1 Purpose
2 MVS services description
3 MVS envelope headers
- 3.1 checkunzr
- 3.2 unzr
- 3.3 CheckPassportStatus
- 3.4 CheckPassportDMSStatus

Purpose

This page contains documentation on Trembita methods that are provided by Ministry of Internal Affairs (MIA) of Ukraine that are used to validate and obtain of ukrainian citizen's UNZR and PASSPORT documents.

MVS services description

Contains description of input and output parameters for checkunzr, unzr, CheckPassportStatus and CheckPassportDMSStatus services. Also, includes request examples.

MVS envelope headers

Haders of SOAP envelope for MVS methods must be filled with following config parameters:

client (objectType="SUBSYSTEM"):
- xRoadInstance = TREMBITA_SEVDEIR_INSTANCE
- memberClass = TREMBITA_MVS_CLIENT_MEMBER_CLASS
- memberCode - TREMBITA_MVS_CLIENT_MEMBER_CODE
- subsystemCode - TREMBITA_MVS_CLIENT_SUBSYSTEM_CODE
service (objectType="SERVICE"):
- xRoadInstance = TREMBITA_SEVDEIR_INSTANCE
- memberClass = TREMBITA_MVS_SERVICE_MEMBER_CLASS
- memberCode - TREMBITA_MVS_SERVICE_MEMBER_CODE
- subsystemCode - TREMBITA_MVS_SERVICE_SUBSYSTEM_CODE
- serviceCode - code of service that is being provided
- serviceVersion - service version
userId - TREMBITA_SEVDEIR_USERID
id - autogenerate request uuid
protocolVersion - TREMBITA_SEVDEIR_PROTOCOL_VERSION

More on config parameters: https://e-health-ua.atlassian.net/wiki/spaces/EH/pages/18247778411

checkunzr

Name	Verification of the universal entry number in the register (MIA)
Service name	checkunzr
Service version	is absent
Purpose	Verification of a person's compliance with the UNZR by surname, first name, patronymic, date of birth and UNZR
Subsystem identifier	20_EIS_prod
Operating mode	Around the clock (24/7)
WSDL

Request example:

curl --location --request POST 'http://10.40.26.61:80' -s \
--header 'Content-Type: application/soap+xml;charset=UTF-8;action="urn:checkunzr"' \
--data-raw '
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:xro="http://x-road.eu/xsd/xroad.xsd" xmlns:iden="http://x-road.eu/xsd/identifiers" xmlns:xs="http://www.w3.org/2001/XMLSchema">
   <soap:Header>
      <xro:client iden:objectType="SUBSYSTEM">
         <iden:xRoadInstance>SEVDEIR-TEST</iden:xRoadInstance>
         <iden:memberClass>GOV</iden:memberClass>
         <iden:memberCode>42032422</iden:memberCode>
         <!--Optional:-->
         <iden:subsystemCode>50_eHealth_preprod_MPIVerificationMVS_cons</iden:subsystemCode>
      </xro:client>
      <xro:service iden:objectType="SERVICE">
         <iden:xRoadInstance>SEVDEIR-TEST</iden:xRoadInstance>
         <iden:memberClass>GOV</iden:memberClass>
         <iden:memberCode>00032684</iden:memberCode>
         <!--Optional:-->
         <iden:subsystemCode>20_EIS_prod</iden:subsystemCode>
         <iden:serviceCode>checkunzr</iden:serviceCode>
      </xro:service>
      <xro:userId>123</xro:userId>
      <xro:id>123</xro:id>
      <xro:protocolVersion>4.0</xro:protocolVersion>
   </soap:Header>
   <soap:Body>
      <xs:checkunzr>
         <xs:UNZR>19701231-01811</xs:UNZR>
         <xs:givenName>іван</xs:givenName>
         <xs:familyName>іванов</xs:familyName>
         <xs:patronymicName>іванович</xs:patronymicName>
         <xs:dateBirth>1970-12-31</xs:dateBirth>
      </xs:checkunzr>
   </soap:Body>
</soap:Envelope>'

Response example:

<soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope"
    xmlns:xroad="http://x-road.eu/xsd/xroad.xsd"
    xmlns:id="http://x-road.eu/xsd/identifiers">
    <soapenv:Header>
        <xroad:userId>123</xroad:userId>
        <xroad:client id:objectType="SUBSYSTEM">
            <id:xRoadInstance>SEVDEIR-TEST</id:xRoadInstance>
            <id:memberClass>GOV</id:memberClass>
            <id:memberCode>00000004</id:memberCode>
            <id:subsystemCode>2_TEST_cons</id:subsystemCode>
        </xroad:client>
        <xroad:service id:objectType="SERVICE">
            <id:xRoadInstance>SEVDEIR-TEST</id:xRoadInstance>
            <id:memberClass>GOV</id:memberClass>
            <id:memberCode>00032684</id:memberCode>
            <id:subsystemCode>20_MIA_prod</id:subsystemCode>
            <id:serviceCode>checkunzr</id:serviceCode>
        </xroad:service>
        <xroad:protocolVersion>4.0</xroad:protocolVersion>
        <xroad:id>123</xroad:id>
        <xroad:requestHash algorithmId="http://www.w3.org/2001/04/xmldsig-more#gost34311">GBO5uaqp/C6Yci3KUsvqaLXI3DfAIi+zO08jcTNjkM4=</xroad:requestHash>
    </soapenv:Header>
    <soapenv:Body>
        <checkunzr xmlns="http://ws.apache.org/ns/synapse">
            <Status>1</Status>
            <Description>Інформація міститься в ЄДДР</Description>
        </checkunzr>
    </soapenv:Body>
</soapenv:Envelope>

unzr

Name	Obtaining personal information on the UNZR
Service name	unzr
Service version	is absent
Purpose	Receiving personal information of Persons by its UNZR
Subsystem identifier	20_EIS_prod
Operating mode	Around the clock (24/7)
WSDL

Request example:

curl --location --request POST 'http://10.40.26.61:80' -s \
--header 'Content-Type: application/soap+xml;charset=UTF-8;action="urn:unzr"' \
--data-raw '
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:xro="http://x-road.eu/xsd/xroad.xsd" xmlns:iden="http://x- road.eu/xsd/identifiers" xmlns:xs="http://www.w3.org/2001/XMLSchema">
   <soap:Header>
      <xro:client iden:objectType="SUBSYSTEM">
         <iden:xRoadInstance>SEVDEIR-TEST</iden:xRoadInstance>
         <iden:memberClass>GOV</iden:memberClass>
         <iden:memberCode>00000004</iden:memberCode>
         <iden:subsystemCode>2_TEST_cons</iden:subsystemCode>
      </xro:client>
      <xro:service iden:objectType="SERVICE">
         <iden:xRoadInstance>SEVDEIR-TEST</iden:xRoadInstance>
         <iden:memberClass>GOV</iden:memberClass>
         <iden:memberCode>00032684</iden:memberCode>
         <iden:subsystemCode>20_MIA_prod</iden:subsystemCode>
         <iden:serviceCode>unzr</iden:serviceCode>
      </xro:service>
      <xro:userId>123</xro:userId><xro:id>123</xro:id>
      <xro:protocolVersion>4.0</xro:protocolVersion> 
   </soap:Header>
   <soap:Body>
      <xs:unzr> 
         <xs:UNZR>19901231-00000</xs:UNZR>
      </xs:unzr>
   </soap:Body>
</soap:Envelope>'

Response example:

CheckPassportStatus

Name	Checking the passport of a citizen of Ukraine among stolen and lost ones
Service name	CheckPassportStatus
Service version	v0.2
Purpose	Checking the passport of a citizen of Ukraine among stolen and lost ones
Subsystem identifier	20_MIA_prod
Operating mode	Around the clock (24/7)
WSDL

Request example:

Response example:

CheckPassportDMSStatus

Name	Verification of the passport of a citizen of Ukraine among invalids
Service name	CheckPassportDMSStatus
Service version	v0.3
Purpose	Search for a passport of a citizen of Ukraine among invalid ones
Subsystem identifier	20_MIA_prod
Operating mode	Around the clock (24/7)
WSDL

Request example:

Response example:

E-Health

RC_MVS Trembita methods_EN (DMS)

Purpose

MVS services description

MVS envelope headers

checkunzr

unzr

CheckPassportStatus

CheckPassportDMSStatus