ЕСОЗ - публічна документація

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Current »

Purpose

This page contains documentation on Trembita methods that are provided by Ministry of Justice of Ukraine that are used to get Death certificate of ukrainian citizens with detailed information.

DRACS envelope headers

Headers of SOAP envelope for DRACS methods must be filled with following config parameters:

  • client (objectType="SUBSYSTEM"):

    • xRoadInstance = TREMBITA_SEVDEIR_INSTANCE

    • memberClass = TREMBITA_DRACS_CLIENT_MEMBER_CLASS

    • memberCode - TREMBITA_DRACS_CLIENT_MEMBER_CODE

    • subsystemCode - configured for each separate method

  • service (objectType="SERVICE"):

    • xRoadInstance = TREMBITA_SEVDEIR_INSTANCE

    • memberClass = TREMBITA_DRACS_SERVICE_MEMBER_CLASS

    • memberCode - TREMBITA_DRACS_SERVICE_MEMBER_CODE

    • subsystemCode - TREMBITA_DRACS_SERVICE_SUBSYSTEM_CODE

    • serviceCode - code of service that is being provided

    • serviceVersion - absent from request

  • 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/DRACS/pages/17249075330

Death act records methods

GetDeathArByRegDatePeriod

Name

Application software interface (service) for downloading data of death act records by registration date period

Service name

GetDeathArByRegDatePeriod

Purpose

Get death act records data by registation date period

Subsystem identifier

3_MJU_DRACS_prod

Operating mode

Around the clock (24/7)

WSDL

Input params

Nesting level

Code

Description

Data type (according to XML specification)

Required

1

DateFrom

Start date of the period for which the death act records data is provided

xs:date

yes

1

DateTo

End date of the period for which the death act records data is provided

xs:date

yes

Request example:

 GetDeathArByRegDatePeriod
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xro="http://x-road.eu/xsd/xroad.xsd" xmlns:iden="http://x-road.eu/xsd/identifiers" xmlns:tem="http://tempuri.org/">
    <soapenv:Header>
        <xro:client iden:objectType="SUBSYSTEM">
            <iden:xRoadInstance>SEVDEIR-TEST</iden:xRoadInstance>
            <iden:memberClass>GOV</iden:memberClass>
            <iden:memberCode>42032422</iden:memberCode>
            <iden:subsystemCode>50_eHealth_preprod_MPIVerificationDRACS_cons</iden:subsystemCode>
        </xro:client>
        <xro:service iden:objectType="SERVICE">
            <iden:xRoadInstance>SEVDEIR-TEST</iden:xRoadInstance>
            <iden:memberClass>GOV</iden:memberClass>
            <iden:memberCode>00015622</iden:memberCode>
            <iden:subsystemCode>3_MJU_DRACS_prod</iden:subsystemCode>
            <iden:serviceCode>GetDeathArByRegDatePeriod</iden:serviceCode>
        </xro:service>
        <xro:userId>test</xro:userId>
        <xro:id>58f1c195-8e91-4e73-9512-4d9e140620fe</xro:id>
        <xro:protocolVersion>4.0</xro:protocolVersion>
    </soapenv:Header>
    <soapenv:Body>
        <tem:ArServiceRequest>
            <tem:DateFrom>2022-09-22</tem:DateFrom>
            <tem:DateTo>2022-09-22</tem:DateTo>
        </tem:ArServiceRequest>
    </soapenv:Body>
</soapenv:Envelope>

Response

Nesting level

Code

Description

Data type (according to XML specification)

Required

1

ResultCode

Result code of request

Values:

  • 0 - successfully completed;

  • 1 - internal error;

  • 2 - not allowed for this client;

  • 3 - more than one active service;

  • 4 - fields are not specified;

  • 5 - incorrect input parameters (validation failed)

xs:string

yes

1

ResultData

XML data with death act records details based on inpuit params, encoded in Base64 (returned if ResultCode = 0)

XML file format is described in https://e-health-ua.atlassian.net/wiki/spaces/DRACS/pages/17249173625/DRACS+Trembita+methods_ph2_EN#DeathArResultData

xs:string

no

1

ErrorInfo

Error information (returned if ResultCode <> 0)

xs:string

no

Response example (success):

 GetDeathArByRegDatePeriodResponse
<?xml version="1.0" encoding="UTF-8"?>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xroad="http://x-road.eu/xsd/xroad.xsd" xmlns:id="http://x-road.eu/xsd/identifiers">
    <s:Header>
        <xroad:userId>test</xroad:userId>
        <xroad:client id:objectType="SUBSYSTEM">
            <id:xRoadInstance>SEVDEIR-TEST</id:xRoadInstance>
            <id:memberClass>GOV</id:memberClass>
            <id:memberCode>42032422</id:memberCode>
            <id:subsystemCode>50_eHealth_preprod_MPIVerificationDRACS_cons</id:subsystemCode>
        </xroad:client>
        <xroad:service id:objectType="SERVICE">
            <id:xRoadInstance>SEVDEIR-TEST</id:xRoadInstance>
            <id:memberClass>GOV</id:memberClass>
            <id:memberCode>00015622</id:memberCode>
            <id:subsystemCode>3_MJU_DRACS_prod</id:subsystemCode>
            <id:serviceCode>GetDeathArByRegDatePeriod</id:serviceCode>
        </xroad:service>
        <xroad:protocolVersion>4.0</xroad:protocolVersion>
        <xroad:id>bfeeb25b-9b9d-4280-8a1b-b5652b2e5102</xroad:id>
        <xroad:requestHash algorithmId="http://www.w3.org/2001/04/xmldsig-more#gost34311">tBiYvl17sE6k2ZDw+xA20uMN3DNAf3YEXlpJBP5b1ik=</xroad:requestHash>
    </s:Header>
    <s:Body>
        <ArServiceAnswer xmlns="http://tempuri.org/">
            <ErrorInfo></ErrorInfo>
            <ResultCode>0</ResultCode>
            <ResultData>PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4NCjxBUl9MSVNUIC8+</ResultData>
        </ArServiceAnswer>
    </s:Body>
</s:Envelope>

Response example (error):

 GetDeathArByRegDatePeriodResponse
<?xml version="1.0" encoding="UTF-8"?>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xroad="http://x-road.eu/xsd/xroad.xsd" xmlns:id="http://x-road.eu/xsd/identifiers">
    <s:Header>
        <xroad:userId>test</xroad:userId>
        <xroad:client id:objectType="SUBSYSTEM">
            <id:xRoadInstance>SEVDEIR-TEST</id:xRoadInstance>
            <id:memberClass>GOV</id:memberClass>
            <id:memberCode>42032422</id:memberCode>
            <id:subsystemCode>50_eHealth_preprod_MPIVerificationDRACS_cons</id:subsystemCode>
        </xroad:client>
        <xroad:service id:objectType="SERVICE">
            <id:xRoadInstance>SEVDEIR-TEST</id:xRoadInstance>
            <id:memberClass>GOV</id:memberClass>
            <id:memberCode>00015622</id:memberCode>
            <id:subsystemCode>3_MJU_DRACS_prod</id:subsystemCode>
            <id:serviceCode>GetDeathArByRegDatePeriod</id:serviceCode>
        </xroad:service>
        <xroad:protocolVersion>4.0</xroad:protocolVersion>
        <xroad:id>bfeeb25b-9b9d-4280-8a1b-b5652b2e5102</xroad:id>
        <xroad:requestHash algorithmId="http://www.w3.org/2001/04/xmldsig-more#gost34311">mUIsVWsthqcT+KlnEDW5FbW5heb550p6r/5dR8PwaX4=</xroad:requestHash>
    </s:Header>
    <s:Body>
        <ArServiceAnswer xmlns="http://tempuri.org/">
            <ErrorInfo>'Дата з' не може бути пізнішою за 'Дата по'</ErrorInfo>
            <ResultCode>5</ResultCode>
            <ResultData></ResultData>
        </ArServiceAnswer>
    </s:Body>
</s:Envelope>

GetDeathArByFullNameAndBirthDate

Name

Application software interface (service) for downloading data of death act records by name and date of birth of deceased person

Service name

GetDeathArByFullNameAndBirthDate

Purpose

Get death act records data by name and date of birth of deceased person

Subsystem identifier

3_MJU_DRACS_prod

Operating mode

Around the clock (24/7)

WSDL

Input params

Nesting level

Code

Description

Data type (according to XML specification)

Required

1

Name

Persons name (first name)

xs:string

yes

1

OnDate

Persons birth date

xs:data

yes

1

Patronymic

Persons patronymic (second name)

xs:string

yes

1

Surname

Persons surname (last name)

xs:string

yes

Request example:

 GetDeathArByFullNameAndBirthDate
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xro="http://x-road.eu/xsd/xroad.xsd" xmlns:iden="http://x-road.eu/xsd/identifiers" xmlns:tem="http://tempuri.org/">
     <soapenv:Header>
        <xro:client iden:objectType="SUBSYSTEM">
           <iden:xRoadInstance>SEVDEIR-TEST</iden:xRoadInstance>
           <iden:memberClass>GOV</iden:memberClass>
           <iden:memberCode>42032422</iden:memberCode>
           <iden:subsystemCode>50_eHealth_preprod_DRACS_Death_cons</iden:subsystemCode>
        </xro:client>
        <xro:service iden:objectType="SERVICE">
           <iden:xRoadInstance>SEVDEIR-TEST</iden:xRoadInstance>
           <iden:memberClass>GOV</iden:memberClass>
           <iden:memberCode>00015622</iden:memberCode>
           <iden:subsystemCode>3_MJU_DRACS_prod</iden:subsystemCode>
           <iden:serviceCode>GetDeathArByFullNameAndBirthDate</iden:serviceCode>
        </xro:service>
        <xro:userId>test</xro:userId>
        <xro:id>d6c38aa0-f392-4c52-a478-ffb41af61b6d</xro:id>
        <xro:protocolVersion>4.0</xro:protocolVersion>
     </soapenv:Header>
     <soapenv:Body>
        <tem:ArServiceRequest>
           <tem:Name>Григорій</tem:Name>
           <tem:OnDate>1933-08-09</tem:OnDate>
           <tem:Patronymic>Олегович</tem:Patronymic>
           <tem:Surname>Гора</tem:Surname>
        </tem:ArServiceRequest>
     </soapenv:Body>
  </soapenv:Envelope>

Response

Nesting level

Code

Description

Data type (according to XML specification)

Required

1

ResultCode

Result code of request

Values:

  • 0 - successfully completed;

  • 1 - internal error;

  • 2 - not allowed for this client;

  • 3 - more than one active service;

  • 4 - fields are not specified;

  • 5 - incorrect input parameters (validation failed)

xs:string

yes

1

ResultData

XML data with death act records details based on inpuit params, encoded in Base64 (returned if ResultCode = 0)

XML file format is described in https://e-health-ua.atlassian.net/wiki/spaces/DRACS/pages/17249173625/DRACS+Trembita+methods_ph2_EN#DeathArResultData

xs:string

no

1

ErrorInfo

Error information (returned if ResultCode <> 0)

xs:string

no

Response example (success):

 GetDeathArByFullNameAndBirthDateResponse
<?xml version="1.0" encoding="UTF-8"?>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xroad="http://x-road.eu/xsd/xroad.xsd" xmlns:id="http://x-road.eu/xsd/identifiers">
    <s:Header>
        <xroad:userId>emal</xroad:userId>
        <xroad:client id:objectType="SUBSYSTEM">
            <id:xRoadInstance>SEVDEIR-TEST</id:xRoadInstance>
            <id:memberClass>GOV</id:memberClass>
            <id:memberCode>42032422</id:memberCode>
            <id:subsystemCode>50_eHealth_preprod_DRACS_Death_cons</id:subsystemCode>
        </xroad:client>
        <xroad:service id:objectType="SERVICE">
            <id:xRoadInstance>SEVDEIR-TEST</id:xRoadInstance>
            <id:memberClass>GOV</id:memberClass>
            <id:memberCode>00015622</id:memberCode>
            <id:subsystemCode>3_MJU_DRACS_prod</id:subsystemCode>
            <id:serviceCode>GetDeathArByFullNameAndBirthDate</id:serviceCode>
        </xroad:service>
        <xroad:protocolVersion>4.0</xroad:protocolVersion>
        <xroad:id>315a6d27-1980-4a99-8b0c-a62ecdcf9b8d</xroad:id>
        <xroad:requestHash algorithmId="http://www.w3.org/2001/04/xmldsig-more#gost34311">/0zgvOsAALZ7sapzsLK41am1bwiesSJ/s0W/2kEP1Xk=</xroad:requestHash>
    </s:Header>
    <s:Body>
        <ArServiceAnswer xmlns="http://tempuri.org/">
            <ErrorInfo></ErrorInfo>
            <ResultCode>0</ResultCode>
            <ResultData>PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4NCjxBUl9MSVNUPg0KICA8QUNUX1JFQ09SRD4NCiAgICA8QXJSZWdEYXRlPjIwMjItMDctMDZUMTU6MDI6MDU8L0FyUmVnRGF0ZT4NCiAgICA8QXJSZWdOdW1iZXI+MDAxNDM1MDY3MTU8L0FyUmVnTnVtYmVyPg0KICAgIDxPUF9EQVRFPjIwMjItMDctMDZUMTU6MDI6MDU8L09QX0RBVEU+DQogICAgPEFSX09QX05BTUU+MTwvQVJfT1BfTkFNRT4NCiAgICA8UmVnTnVtYj41NDQ8L1JlZ051bWI+DQogICAgPENvbXBvc2VEYXRlPjA2LjA3LjIwMjI8L0NvbXBvc2VEYXRlPg0KICAgIDxDb21wb3NlT3JnPtCS0ZbQtNC00ZbQuyDQtNC10YDQttCw0LLQvdC+0Zcg0YDQtdGU0YHRgtGA0LDRhtGW0Zcg0LDQutGC0ZbQsiDRhtC40LLRltC70YzQvdC+0LPQviDRgdGC0LDQvdGDINGDINCS0L7Qu9C40L3RgdGM0LrRltC5INC+0LHQu9Cw0YHRgtGWINCj0L/RgNCw0LLQu9GW0L3QvdGPINC00LXRgNC20LDQstC90L7RlyDRgNC10ZTRgdGC0YDQsNGG0ZbRlyDQl9Cw0YXRltC00L3QvtCz0L4g0LzRltC20YDQtdCz0ZbQvtC90LDQu9GM0L3QvtCz0L4g0YPQv9GA0LDQstC70ZbQvdC90Y8g0JzRltC90ZbRgdGC0LXRgNGB0YLQstCwINGO0YHRgtC40YbRltGXICjQvC7Qm9GM0LLRltCyKTwvQ29tcG9zZU9yZz4NCiAgICA8SVNfUkVTVE9SRT4wPC9JU19SRVNUT1JFPg0KICAgIDxTdXJuYW1lPtCT0L7RgNCwPC9TdXJuYW1lPg0KICAgIDxOYW1lPtCT0YDQuNCz0L7RgNGW0Lk8L05hbWU+DQogICAgPFBhdHJvbnltaWM+0J7Qu9C10LPQvtCy0LjRhzwvUGF0cm9ueW1pYz4NCiAgICA8RGF0ZUJpcnRoPjA5LjA4LjE5MzM8L0RhdGVCaXJ0aD4NCiAgICA8RGF0ZURlYXRoPjA1LjA3LjIwMjI8L0RhdGVEZWF0aD4NCiAgICA8QUdFPjg4PC9BR0U+DQogICAgPEJpcnRoU3RhdGU+0KPQutGA0LDRl9C90LA8L0JpcnRoU3RhdGU+DQogICAgPEJpcnRoUmVnaW9uPtCn0LXRgNC90ZbQs9GW0LLRgdGM0LrQsDwvQmlydGhSZWdpb24+DQogICAgPEJpcnRoRGlzdHJpY3Q+0JHQvtGA0LfQvdGP0L3RgdGM0LrQuNC5PC9CaXJ0aERpc3RyaWN0Pg0KICAgIDxCaXJ0aExvY2FsaXR5VHlwZT7QodC10LvQvjwvQmlydGhMb2NhbGl0eVR5cGU+DQogICAgPEJpcnRoTG9jYWxpdHk+0JHQtdGA0LXQt9GW0LLQutCwPC9CaXJ0aExvY2FsaXR5Pg0KICAgIDxEZWF0aFN0YXRlPtCj0LrRgNCw0ZfQvdCwPC9EZWF0aFN0YXRlPg0KICAgIDxEZWF0aFJlZ2lvbj7Ql9Cw0LrQsNGA0L/QsNGC0YHRjNC60LA8L0RlYXRoUmVnaW9uPg0KICAgIDxEZWF0aERpc3RyaWN0PtCS0L7Qu9C+0LLQtdGG0YzQutC40Lk8L0RlYXRoRGlzdHJpY3Q+DQogICAgPERlYXRoTG9jYWxpdHlUeXBlPtCh0ZbQu9GM0YDQsNC00LA8L0RlYXRoTG9jYWxpdHlUeXBlPg0KICAgIDxEZWF0aExvY2FsaXR5PtCR0ZbQu9Cw0YHQvtCy0LjRhtGM0LrQsDwvRGVhdGhMb2NhbGl0eT4NCiAgICA8Q0VSVElGSUNBVEVTPg0KICAgICAgPENFUlRJRklDQVRFPg0KICAgICAgICA8Q2VydFN0YXR1cz4xPC9DZXJ0U3RhdHVzPg0KICAgICAgICA8Q2VydFNlcmlhbD5JSS3QkdCaPC9DZXJ0U2VyaWFsPg0KICAgICAgICA8Q2VydE51bWJlcj41Njc3ODg8L0NlcnROdW1iZXI+DQogICAgICAgIDxDZXJ0T3JnPtCS0ZbQtNC00ZbQuyDQtNC10YDQttCw0LLQvdC+0Zcg0YDQtdGU0YHRgtGA0LDRhtGW0Zcg0LDQutGC0ZbQsiDRhtC40LLRltC70YzQvdC+0LPQviDRgdGC0LDQvdGDINGDINCS0L7Qu9C40L3RgdGM0LrRltC5INC+0LHQu9Cw0YHRgtGWINCj0L/RgNCw0LLQu9GW0L3QvdGPINC00LXRgNC20LDQstC90L7RlyDRgNC10ZTRgdGC0YDQsNGG0ZbRlyDQl9Cw0YXRltC00L3QvtCz0L4g0LzRltC20YDQtdCz0ZbQvtC90LDQu9GM0L3QvtCz0L4g0YPQv9GA0LDQstC70ZbQvdC90Y8g0JzRltC90ZbRgdGC0LXRgNGB0YLQstCwINGO0YHRgtC40YbRltGXICjQvC7Qm9GM0LLRltCyKTwvQ2VydE9yZz4NCiAgICAgICAgPENlcnREYXRlPjA2LjA3LjIwMjI8L0NlcnREYXRlPg0KICAgICAgICA8Q2VydFJlcGVhdD4wPC9DZXJ0UmVwZWF0Pg0KICAgICAgPC9DRVJUSUZJQ0FURT4NCiAgICA8L0NFUlRJRklDQVRFUz4NCiAgICA8RE9DX1JFQVNPTlM+DQogICAgICA8RE9DX1JFQVNPTj4NCiAgICAgICAgPERvY05hbWU+0JTQvtCy0ZbQtNC60LA8L0RvY05hbWU+DQogICAgICAgIDxEb2NOdW1iZXI+Nzc8L0RvY051bWJlcj4NCiAgICAgICAgPERvY0RlbGl2ZXI+0JvRltC60LDRgNC90Y88L0RvY0RlbGl2ZXI+DQogICAgICAgIDxEb2NEYXRlPjA2LjA3LjIwMjI8L0RvY0RhdGU+DQogICAgICA8L0RPQ19SRUFTT04+DQogICAgPC9ET0NfUkVBU09OUz4NCiAgICA8RE9DX1NFSVpFUyAvPg0KICA8L0FDVF9SRUNPUkQ+DQo8L0FSX0xJU1Q+</ResultData>
        </ArServiceAnswer>
    </s:Body>
</s:Envelope>

Response example (error):

 GetDeathArByFullNameAndBirthDateResponse
<?xml version="1.0" encoding="UTF-8"?>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xroad="http://x-road.eu/xsd/xroad.xsd" xmlns:id="http://x-road.eu/xsd/identifiers">
    <s:Header>
        <xroad:userId>emal</xroad:userId>
        <xroad:client id:objectType="SUBSYSTEM">
            <id:xRoadInstance>SEVDEIR-TEST</id:xRoadInstance>
            <id:memberClass>GOV</id:memberClass>
            <id:memberCode>42032422</id:memberCode>
            <id:subsystemCode>50_eHealth_preprod_DRACS_Death_cons</id:subsystemCode>
        </xroad:client>
        <xroad:service id:objectType="SERVICE">
            <id:xRoadInstance>SEVDEIR-TEST</id:xRoadInstance>
            <id:memberClass>GOV</id:memberClass>
            <id:memberCode>00015622</id:memberCode>
            <id:subsystemCode>3_MJU_DRACS_prod</id:subsystemCode>
            <id:serviceCode>GetDeathArByFullNameAndBirthDate</id:serviceCode>
        </xroad:service>
        <xroad:protocolVersion>4.0</xroad:protocolVersion>
        <xroad:id>51ad339b-d21d-4876-b68c-b6c6f68936d1</xroad:id>
        <xroad:requestHash algorithmId="http://www.w3.org/2001/04/xmldsig-more#gost34311">Tms8PgphHR4JqRJvcuLSrX6ls7KOcGGSuDkiPj+I7mY=</xroad:requestHash>
    </s:Header>
    <s:Body>
        <ArServiceAnswer xmlns="http://tempuri.org/">
            <ErrorInfo>'Name' must not be empty.; 'Ім'я' не може бути порожнім; 'Дата' не може бути порожньою</ErrorInfo>
            <ResultCode>5</ResultCode>
            <ResultData></ResultData>
        </ArServiceAnswer>
    </s:Body>
</s:Envelope>

DeathArResultData

XML file contains AR_LIST array with ACT_RECORD objects, each object contains following fields:

 DeathArResultData

Code

Description

Type and length

Note

Required

Act record in registry details

ArRegDate

Act record date in registry

date

Date and time in 2019-03-26T00:00:00 format

yes

ArRegNumber

Act record number in registry

string(11)

Numbers only

yes

OP_DATE

Date of last operation with act record

date

Date and time in 2019-03-26T00:00:00 format

yes

AR_OP_NAME

Name of last operation with act record

number(2)

1 - Registration

2 - Removal

3 - Cancellation

4 - Changes

yes

RegNumb

Act record number in the book of state registration of deaths

string(18)

Numbers only

no

СomposeDate

Act record compose date

string(10)

no

ComposeOrg

The state organization that composed act record

string(240)

no

IS_RESTORE

Restored (renewed) flag

number(1)

0 - no

1 - yes

yes

Death certificates details (CERTIFICATES array with CERTIFICATE objects)

CertStatus

Death certificate status

number(2)

1 - valid

no

CertSerialNumber

Death certificate serial number

string(21)

CertSerial (up to 10 symbols) + CertNumber (11 numbers)

no

CertSerial

Death certificate serial

string(10)

Up to 10 symbols

no

CertNumber

Death certificate number

string(11)

11 numbers

no

CertOrg

The state organization that composed death certificate

string(240)

no

CertDate

Death certificate compose date

string(10)

no

CertIsRepeat

Repeated flag

number(1)

0 - no

1 - yes

no

Deceased person details

Surname

Last name

string(50)

no

Name

First name

string(50)

no

Patronymic

Second name

string(50)

no

Sex

Gender

string(1)

1 - male

2 - female

yes

Numident

Individual tax number (tax_id)

string(10)

no

Сitizenship

Citizenship type

number(2)

82 - stateless person;

83 - male citizen of Ukraine;

84 - female citizen of Ukraine;

85 - other

no

СitizenshipAnother

Othe citizenship details

string(240)

Is provided when Citizenship = 85

no

DateBirth

Birth date

string(10)

no

DateDeath

Death date

string(10)

no

AGE

Age

number(3)

no

Data on the document confirming the fact of death (DOC_REASONS array with DOC_REASON objects)

DocName

Document name

string(100)

no

DocNumber

Document number

string(20)

no

DocDeliver

The state organization that composed the document

string(240)

no

DocDate

Document compose date

string(10)

no

DocOpTypeId

Operation type that is associated with the document

number(8)

1 - Act record registration

4 - Changes

no

DocOpSubTypeId

Operation subtype that is associated with the document

number(15)

null for DocOpTypeId = 1

no

Data on seized documents of a deceased person (DOC_SEIZES array with DOC_SEIZE objects)

DocType

Document type

string(1)

1 - passport

2 - other

no

DocName

Other document name

string(100)

Is provided when DocType = 2

no

SERIES_NUMB

Document serial number

string(50)

no

DocDate

The state organization that composed the document

string(10)

no

DocOrgName

Document compose date

string(240)

no

Description

Additional details

string(120)

no

Place of birth of the deceased person

BirthState

Birthplace country name

string(240)

no

BirthRegion

Birthplace region name

string(120)

no

BirthDistrict

Birthplace district name

string(120)

no

BirthLocalityType

Birthplace locality type

string(50)

If exists - is provided according to dictionary.

Possible values: місто, район, селище міського типу, село, селище, сільрада, селищна рада

no

BirthLocality

Birthplace locality name

string(120)

no

Death place

DeathState

Death place country name

string(240)

no

DeathRegion

Death place region name

string(120)

no

DeathDistrict

Death place district name

string(120)

no

DeathLocalityType

Death place locality type

string(50)

If exists - is provided according to dictionary.

Possible values: місто, район, селище міського типу, село, селище, сільрада, селищна рада

no

DeathLocality

Death place locality name

string(120)

no

Place of residence of the deceased person

State

Residence country name

string(240)

no

Region

Residence region name

string(120)

no

District

Residence district name

string(120)

no

LocalityType

Residence locality type

string(50)

If exists - is provided according to dictionary.

Possible values: місто, район, селище міського типу, село, селище, сільрада, селищна рада

no

Locality

Residence locality name

string(120)

no

Street

Residence street name

string(120)

Includes street type

no

House

Residence house number

string(25)

no

BuildingPartType

Residence building part type

string (1)

1 - building (ua: корпус)

2 - section

no

BuildingPart

Residence building part

string(25)

no

Apartment

Residence apartment number

string(25)

no

AR_LIST (list of death certificates) example:

Birth act records methods

GetBirthArByChildNameAndBirthDate

Name

Application software interface (service) for downloading data of birth act records by childs name and date of birth

Service name

GetBirthArByChildNameAndBirthDate

Purpose

Get birth act records data by childs name and date of birth

Subsystem identifier

3_MJU_DRACS_prod

Operating mode

Around the clock (24/7)

WSDL

Input params

Nesting level

Code

Description

Data type (according to XML specification)

Required

1

ChildBirthDate

Child`s birth date

xs:date

yes

1

ChildSurname

Child`s last name

xs:string

yes

1

ChildName

Child`s first name

xs:string

yes

1

ChildPatronymic

Child`s patronymic

xs:string

yes

Request example:

 GetBirthArByChildNameAndBirthDate
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xro="http://x-road.eu/xsd/xroad.xsd" xmlns:iden="http://x-road.eu/xsd/identifiers" xmlns:tem="http://tempuri.org/">
   <soapenv:Header>
      <xro:client iden:objectType="SUBSYSTEM">
         <iden:xRoadInstance>SEVDEIR-TEST</iden:xRoadInstance>
         <iden:memberClass>GOV</iden:memberClass>
         <iden:memberCode>42032422</iden:memberCode>
         <iden:subsystemCode>50_eHealth_preprod_DRACS_Death_cons</iden:subsystemCode>
      </xro:client>
      <xro:service iden:objectType="SERVICE">
         <iden:xRoadInstance>SEVDEIR-TEST</iden:xRoadInstance>
         <iden:memberClass>GOV</iden:memberClass>
         <iden:memberCode>00015622</iden:memberCode>
         <iden:subsystemCode>3_MJU_DRACS_prod</iden:subsystemCode>
         <iden:serviceCode>GetBirthArByChildNameAndBirthDate</iden:serviceCode>
      </xro:service>
      <xro:userId>test</xro:userId>
      <xro:id>d6c38aa0-f392-4c52-a478-ffb41af61b6d</xro:id>
      <xro:protocolVersion>4.0</xro:protocolVersion>
   </soapenv:Header>
   <soapenv:Body>
      <tem:ArBirthServiceRequest>
         <tem:ChildBirthDate>2024-02-19</tem:ChildBirthDate>
         <tem:ChildName>Григорій</tem:ChildName>
         <tem:ChildPatronymic>Олегович</tem:ChildPatronymic>
         <tem:ChildSurname>Гора</tem:ChildSurname>
      </tem:ArBirthServiceRequest>
   </soapenv:Body>
</soapenv:Envelope>

Response

Nesting level

Code

Description

Data type (according to XML specification)

Required

1

ResultCode

Result code of request

Values:

  • 0 - successfully completed;

  • 1 - internal error;

  • 2 - not allowed for this client;

  • 3 - more than one active service;

  • 4 - fields are not specified;

  • 5 - incorrect input parameters (validation failed)

xs:string

yes

1

ResultData

XML data with birth act records details based on inpuit params, encoded in Base64 (returned if ResultCode = 0)

XML file format is described in https://e-health-ua.atlassian.net/wiki/spaces/DRACS2/pages/17858101249#BirthArResultData

xs:string

no

1

ErrorInfo

Error information (returned if ResultCode <> 0)

xs:string

no

Response example (success):

 GetBirthArByChildNameAndBirthDateResponse
<?xml version="1.0" encoding="UTF-8"?>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xroad="http://x-road.eu/xsd/xroad.xsd" xmlns:id="http://x-road.eu/xsd/identifiers">
    <s:Header>
        <xroad:userId>emal</xroad:userId>
        <xroad:client id:objectType="SUBSYSTEM">
            <id:xRoadInstance>SEVDEIR-TEST</id:xRoadInstance>
            <id:memberClass>GOV</id:memberClass>
            <id:memberCode>42032422</id:memberCode>
            <id:subsystemCode>50_eHealth_preprod_DRACS_Death_cons</id:subsystemCode>
        </xroad:client>
        <xroad:service id:objectType="SERVICE">
            <id:xRoadInstance>SEVDEIR-TEST</id:xRoadInstance>
            <id:memberClass>GOV</id:memberClass>
            <id:memberCode>00015622</id:memberCode>
            <id:subsystemCode>3_MJU_DRACS_prod</id:subsystemCode>
            <id:serviceCode>GetBirthArByChildNameAndBirthDate</id:serviceCode>
        </xroad:service>
        <xroad:protocolVersion>4.0</xroad:protocolVersion>
        <xroad:id>315a6d27-1980-4a99-8b0c-a62ecdcf9b8d</xroad:id>
        <xroad:requestHash algorithmId="http://www.w3.org/2001/04/xmldsig-more#gost34311">/0zgvOsAALZ7sapzsLK41am1bwiesSJ/s0W/2kEP1Xk=</xroad:requestHash>
    </s:Header>
    <s:Body>
        <ArBirthServiceAnswer xmlns="http://tempuri.org/">
            <ErrorInfo></ErrorInfo>
            <ResultCode>0</ResultCode>
            <ResultData>PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4KPEFSX0xJU1Q+CiAgPEFDVF9SRUNPUkQ+CiAgICA8QXJSZWdEYXRlPjIwMjAtMDYtMTBUMTA6MjQ6MjA8L0FyUmVnRGF0ZT4KICAgIDxBclJlZ051bWJlcj4wMDExMzc5Mjc4NDwvQXJSZWdOdW1iZXI+CiAgICA8T1BfREFURT4yMDIxLTA0LTIwVDEwOjI2OjIzPC9PUF9EQVRFPgogICAgPEFSX09QX05BTUU+NDwvQVJfT1BfTkFNRT4KICAgIDxSZWdOdW1iPjIwNjwvUmVnTnVtYj4KICAgIDxDb21wb3NlRGF0ZT4xMC4wNi4yMDIwPC9Db21wb3NlRGF0ZT4KICAgIDxDb21wb3NlT3JnPtCT0L7RgNC+0YXRltCy0YHRjNC60LjQuSDRgNCw0LnQvtC90L3QuNC5INCy0ZbQtNC00ZbQuyDQtNC10YDQttCw0LLQvdC+0Zcg0YDQtdGU0YHRgtGA0LDRhtGW0Zcg0LDQutGC0ZbQsiDRhtC40LLRltC70YzQvdC+0LPQviDRgdGC0LDQvdGDINCT0L7Qu9C+0LLQvdC+0LPQviDRgtC10YDQuNGC0L7RgNGW0LDQu9GM0L3QvtCz0L4g0YPQv9GA0LDQstC70ZbQvdC90Y8g0Y7RgdGC0LjRhtGW0Zcg0YMg0JLQvtC70LjQvdGB0YzQutGW0Lkg0L7QsdC70LDRgdGC0ZY8L0NvbXBvc2VPcmc+CiAgICA8UmNjX3JjY19pZD4xPC9SY2NfcmNjX2lkPgogICAgPElTX1JFU1RPUkU+MDwvSVNfUkVTVE9SRT4KICAgIDxGYXRoZXJQYXJlbnRSaWdodHM+MTgzPC9GYXRoZXJQYXJlbnRSaWdodHM+CiAgICA8TW90aGVyUGFyZW50UmlnaHRzPjE4MjwvTW90aGVyUGFyZW50UmlnaHRzPgogICAgPENoaWxkU3VybmFtZT7QkdGD0YDQutC+PC9DaGlsZFN1cm5hbWU+CiAgICA8Q2hpbGROYW1lPtCf0LXRgtGA0L48L0NoaWxkTmFtZT4KICAgIDxDaGlsZFBhdHJvbnltaWM+0J/QtdGC0YDQvtCy0LjRhzwvQ2hpbGRQYXRyb255bWljPgogICAgPENoaWxkU2V4PjE8L0NoaWxkU2V4PgogICAgPENoaWxkRGF0ZUJpcnRoPjE1LjA4LjIwMTk8L0NoaWxkRGF0ZUJpcnRoPgogICAgPENoaWxkcmVuV2VyZUJvcm4+MTwvQ2hpbGRyZW5XZXJlQm9ybj4KICAgIDxDaGlsZEJvcm5BbGl2ZT4xPC9DaGlsZEJvcm5BbGl2ZT4KICAgIDxDaGlsZEJvcm5PcmRlcj4xPC9DaGlsZEJvcm5PcmRlcj4KICAgIDxDaGlsZEJpcnRoU3RhdGU+0KPQutGA0LDRl9C90LA8L0NoaWxkQmlydGhTdGF0ZT4KICAgIDxDaGlsZEJpcnRoUmVnaW9uPtCX0LDQutCw0YDQv9Cw0YLRgdGM0LrQsDwvQ2hpbGRCaXJ0aFJlZ2lvbj4KICAgIDxDaGlsZEJpcnRoRGlzdHJpY3Q+0JLQuNC90L7Qs9GA0LDQtNGW0LLRgdGM0LrQuNC5PC9DaGlsZEJpcnRoRGlzdHJpY3Q+CiAgICA8Q2hpbGRCaXJ0aExvY2FsaXR5VHlwZT7QodGW0LvRjNGA0LDQtNCwPC9DaGlsZEJpcnRoTG9jYWxpdHlUeXBlPgogICAgPENoaWxkQmlydGhMb2NhbGl0eT7QkdGD0LrRltCy0YHRjNC60LA8L0NoaWxkQmlydGhMb2NhbGl0eT4KICAgIDxGYXRoZXJTdXJuYW1lPtCR0YPRgNC60L48L0ZhdGhlclN1cm5hbWU+CiAgICA8RmF0aGVyTmFtZT7QlNC80LjRgtGA0L48L0ZhdGhlck5hbWU+CiAgICA8RmF0aGVyUGF0cm9ueW1pYz7Qn9C10YLRgNC+0LLQuNGHPC9GYXRoZXJQYXRyb255bWljPgogICAgPEZhdGhlckRhdGVCaXJ0aD4xOS4wNy4xOTgwPC9GYXRoZXJEYXRlQmlydGg+CiAgICA8RmF0aGVyQ2l0aXplbnNoaXA+ODM8L0ZhdGhlckNpdGl6ZW5zaGlwPgogICAgPEZhdGhlclN0YXRlPtCj0LrRgNCw0ZfQvdCwPC9GYXRoZXJTdGF0ZT4KICAgIDxGYXRoZXJSZWdpb24+0JTQvtC90LXRhtGM0LrQsDwvRmF0aGVyUmVnaW9uPgogICAgPEZhdGhlckRpc3RyaWN0PtCQ0YDRgtC10LzRltCy0YHRjNC60LjQuTwvRmF0aGVyRGlzdHJpY3Q+CiAgICA8RmF0aGVyTG9jYWxpdHlUeXBlPtCh0LXQu9C+PC9GYXRoZXJMb2NhbGl0eVR5cGU+CiAgICA8RmF0aGVyTG9jYWxpdHk+0JrRgNCw0YHQvdC40Lkg0J/QsNGF0LDRgDwvRmF0aGVyTG9jYWxpdHk+CiAgICA8RmF0aGVyU3RyZWV0PtCy0YPQuy4g0JzQvtC70L7QtNGW0LbQvdCwPC9GYXRoZXJTdHJlZXQ+CiAgICA8RmF0aGVySG91c2U+MjwvRmF0aGVySG91c2U+CiAgICA8RmF0aGVyQnVpbGRpbmdQYXJ0PjI8L0ZhdGhlckJ1aWxkaW5nUGFydD4KICAgIDxGYXRoZXJCdWlsZGluZ1BhcnRUeXBlPjE8L0ZhdGhlckJ1aWxkaW5nUGFydFR5cGU+CiAgICA8RmF0aGVyQXBhcnRtZW50PjU8L0ZhdGhlckFwYXJ0bWVudD4KICAgIDxNb3RoZXJTdXJuYW1lPtCR0YPRgNC60L48L01vdGhlclN1cm5hbWU+CiAgICA8TW90aGVyTmFtZT7QntC70LXQvdCwPC9Nb3RoZXJOYW1lPgogICAgPE1vdGhlclBhdHJvbnltaWM+0KHQtdC80LXQvdGW0LLQvdCwPC9Nb3RoZXJQYXRyb255bWljPgogICAgPE1vdGhlckRhdGVCaXJ0aD4wNi4wNy4yMDE4PC9Nb3RoZXJEYXRlQmlydGg+CiAgICA8TW90aGVyQ2l0aXplbnNoaXA+ODQ8L01vdGhlckNpdGl6ZW5zaGlwPgogICAgPE1vdGhlclN0YXRlPtCj0LrRgNCw0ZfQvdCwPC9Nb3RoZXJTdGF0ZT4KICAgIDxNb3RoZXJSZWdpb24+0JrQuNGX0LI8L01vdGhlclJlZ2lvbj4KICAgIDxNb3RoZXJMb2NhbGl0eVR5cGU+0KHQtdC70L48L01vdGhlckxvY2FsaXR5VHlwZT4KICAgIDxNb3RoZXJTdHJlZXQ+0LLRg9C7LiDQkNCy0YLQvtC30LDQstC+0LTRgdGM0LrQsDwvTW90aGVyU3RyZWV0PgogICAgPE1vdGhlckhvdXNlPjU8L01vdGhlckhvdXNlPgogICAgPE1vdGhlckJ1aWxkaW5nUGFydD4xPC9Nb3RoZXJCdWlsZGluZ1BhcnQ+CiAgICA8TW90aGVyQnVpbGRpbmdQYXJ0VHlwZT4xPC9Nb3RoZXJCdWlsZGluZ1BhcnRUeXBlPgogICAgPE1vdGhlckFwYXJ0bWVudD4yPC9Nb3RoZXJBcGFydG1lbnQ+CiAgICA8Q0VSVElGSUNBVEVTPgogICAgICA8Q0VSVElGSUNBVEU+CiAgICAgICAgPENlcnRTdGF0dXM+MTwvQ2VydFN0YXR1cz4KICAgICAgICA8Q2VydFNlcmlhbD7Qhi3QkdCaPC9DZXJ0U2VyaWFsPgogICAgICAgIDxDZXJ0TnVtYmVyPjM2MzU2MjwvQ2VydE51bWJlcj4KICAgICAgICA8Q2VydE9yZz7Qk9C+0YDQvtGF0ZbQstGB0YzQutC40Lkg0YDQsNC50L7QvdC90LjQuSDQstGW0LTQtNGW0Lsg0LTQtdGA0LbQsNCy0L3QvtGXINGA0LXRlNGB0YLRgNCw0YbRltGXINCw0LrRgtGW0LIg0YbQuNCy0ZbQu9GM0L3QvtCz0L4g0YHRgtCw0L3RgyDQk9C+0LvQvtCy0L3QvtCz0L4g0YLQtdGA0LjRgtC+0YDRltCw0LvRjNC90L7Qs9C+INGD0L/RgNCw0LLQu9GW0L3QvdGPINGO0YHRgtC40YbRltGXINGDINCS0L7Qu9C40L3RgdGM0LrRltC5INC+0LHQu9Cw0YHRgtGWPC9DZXJ0T3JnPgogICAgICAgIDxDZXJ0RGF0ZT4xMC4wNi4yMDIwPC9DZXJ0RGF0ZT4KICAgICAgICA8Q2VydFJlcGVhdD4wPC9DZXJ0UmVwZWF0PgogICAgICA8L0NFUlRJRklDQVRFPgogICAgPC9DRVJUSUZJQ0FURVM+CiAgICA8RE9DX1JFQVNPTlM+CiAgICAgIDxET0NfUkVBU09OPgogICAgICAgIDxEb2NOYW1lPtC00L7QstGW0LTQutCwIDEwMzwvRG9jTmFtZT4KICAgICAgICA8RG9jTnVtYmVyPjg1MjwvRG9jTnVtYmVyPgogICAgICAgIDxEb2NEZWxpdmVyPtC70ZbQutCw0YDQvdGPPC9Eb2NEZWxpdmVyPgogICAgICAgIDxEb2NEYXRlPjE5LjA4LjIwMTk8L0RvY0RhdGU+CiAgICAgICAgPERvY09wVHlwZUlkPjE8L0RvY09wVHlwZUlkPgogICAgICA8L0RPQ19SRUFTT04+CiAgICA8L0RPQ19SRUFTT05TPgogICAgPFBBUkVOVF9SSUdIVFNfRE9DPgogICAgICA8RE9DX1JFQVNPTj4KICAgICAgICA8RG9jTmFtZT7QoNGW0YjQtdC90L3RjyDRgdGD0LTRgyA8L0RvY05hbWU+CiAgICAgICAgPERvY051bWJlcj41NjMyNDwvRG9jTnVtYmVyPgogICAgICAgIDxEb2NEZWxpdmVyPtCU0LDRgNC90LjRhtGM0LrQuNC8INGB0YPQtNC+0Lw8L0RvY0RlbGl2ZXI+CiAgICAgICAgPERvY0RhdGU+MDEuMDMuMjAyMTwvRG9jRGF0ZT4KICAgICAgICA8RG9jT3BUeXBlSWQ+NDwvRG9jT3BUeXBlSWQ+CiAgICAgICAgPERvY09wU3ViVHlwZUlkPjc8L0RvY09wU3ViVHlwZUlkPgogICAgICA8L0RPQ19SRUFTT04+CiAgICA8L1BBUkVOVF9SSUdIVFNfRE9DPgogIDwvQUNUX1JFQ09SRD4KPC9BUl9MSVNUPg==</ResultData>
        </ArBirthServiceAnswer>
    </s:Body>
</s:Envelope>

BirthArResultData

 BirthArResultData

Code

Description

Type and length

Note

Required

Act record in registry details

ArRegDate

Act record date in registry

date

Date and time in 2019-03-26T00:00:00 format

yes

ArRegNumber

Act record number in registry

string(11)

Numbers only

yes

OP_DATE

Date of last operation with act record

date

Date and time in 2019-03-26T00:00:00 format

yes

AR_OP_NAME

Name of last operation with act record

number(2)

1 - Registration

2 - Removal

3 - Cancellation

4 - Changes

yes

RegNumb

Act record number in the book of state registration of births

string(18)

Numbers only

no

СomposeDate

Act record compose date

string(10)

 

no

ComposeOrg

The state organization that composed act record

string(240)

 

no

Rcc_rcc_id

Article number Family Code of Ukraine

String(1)

no

IS_RESTORE

Restored (renewed) flag

number(1)

0 - no

1 - yes

yes

Parent Rights

FatherParentRights

A flag about deprivation/restoration paternity father's rights

Number

182 - Missing

183 - Deprived

184 - Restored

no

MotherParentRights

A flag about deprivation/restoration paternity mother's rights

Number

182 - Missing

185 - Deprived

186 - Restored

no

Child`s data

ChildSurname

Child's last name

string (50)

no

ChildName

Child's name

string (50)

no

ChildPatronymic

Child's patronymic

string (50)

no

ChildSex

1 - male

2 - female

String( 1)

no

ChildDateBirth

Date of birth

String(10)

no

Form # 103 data

ChildrenWereBorn

Count of children was born

Number(2)

no

ChildBornAlive

Live birth or
stillborn

Number(2)

no

ChildBornOrder

Order of child

Number(1)

no

Child`s place of birth

ChildBirthState

Name of country

string(240)

no

ChildBirthRegion

Name of region

string(120)

no

ChildBirthDistrict

Name of district

string(120)

no

ChildBirthLocalityType

Value from dictionary

string(50)

no

ChildBirthLocality

The name of the settlement

string(120)

no

Father`s data

FatherSurname

Father's surname

string (50)

no

FatherName

Father's name

string (50)

no

FatherPatronymic

Father's patronymic

string (50)

no

FatherNumident

Father's tax id

string (10)

no

FatherDateBirth

Father's date of birth

string (10)

no

FatherСitizenship

Father’s citizenship

Number(2)

82 - stateless person;

83 - male citizen of Ukraine;

84 - female citizen of Ukraine;

85 - other

no

FatherСitizenshipAnother

Father’s another citizenship

string(240)

Is provided when Citizenship = 85

no

FatherState

Name of father's country of residence

string(240)

no

FatherRegion

Name of father's region of residence

string(120)

no

FatherDistrict

Name of father's district of residence

string(120)

no

FatherLocalityType

Value from dictionary

string (50)

If exists - is provided according to dictionary.

Possible values: місто, район, селище міського типу, село, селище, сільрада, селищна рада

no

FatherLocality

Name of father's settlement of residence

string(120)

no

FatherStreet

Name of father's street of residence

string(120)

no

FatherHouse

Building

string(25)

no

FatherBuildingPart

Number of building part

string(25)

no

FatherBuildingPartType

Type of building part

string(1)

no

FatherApartment

Apartment

string(25)

no

Mother`s data

MotherSurname

Mother's surname

string (50)

no

MotherName

Mother's name

string (50)

no

MotherPatronymic

Mother's patronymic

string (50)

no

MotherNumident

Mother's tax id

string (10)

no

MotherDateBirth

Mother's date of birth

string (10)

no

MotherСitizenship

Mother's citizenship

Number(2)

82 - stateless person;

83 - male citizen of Ukraine;

84 - female citizen of Ukraine;

85 - other

no

MotherСitizenshipAnother

Mother’s another citizenship

string(240)

Is provided when Citizenship = 85

no

MotherState

Name of mother's country of residence

string(240)

no

MotherRegion

Name of mother's region of residence

string(120)

no

MotherDistrict

Name of mother's district of residence

string(120)

no

MotherLocalityType

Value from dictionary

string (50)

If exists - is provided according to dictionary.

Possible values: місто, район, селище міського типу, село, селище, сільрада, селищна радаIf exists - is provided according to dictionary.

Possible values: місто, район, селище міського типу, село, селище, сільрада, селищна рада

no

MotherLocality

Name of mother's settlement of residence

string(120)

no

MotherStreet

Name of mother's street of residence

string(120)

no

MotherHouse

Building

string(25)

no

MotherBuildingPart

Number of building part

string(25)

no

MotherBuildingPartType

Type of building part

string(1)

no

MotherApartment

Apartment

string(25)

no

Certificate of birth data. Section <CERTIFICATES >, subsection <CERTIFICATE> for each documents

CertStatus

Certificate status

1 - valid

Number(2)

no

CertSerial

Certificate series

String(10)

no

CertNumber

Certificate number

String(11)

no

CertOrg

Certificate Issued by

String(240)

no

CertDate

Certificate date

String(10)

no

CertRepeat

Number(1)

1 - yes

0 - no

no

CertSerialNumber

Series and number of certificate about
birth

String(21)

no

Document of child`s birth. Section <DOC_REASONS >, subsection <DOC_REASONS> for each documents

DocName

The name of the document confirming the birth of a child

String(100)

no

DocNumber

The number of the document confirming the birth of a child

String(20)

no

DocDeliver

The issued by of the document confirming the birth of a child

String(10)

no

DocDate

The issued date of the document confirming the birth of a child

String(240)

no

DocOpTypeId

Type of operation related
document

Number(8)

1 - Act record registration

4 - Changes

no

DocOpSubTypeId

Subtype of operation

Number(15)

if doc_op_type_id = 1 this field = null

no

Documents of parents rights

DocName

The name of the document of parents rights

String(100)

Court decision

no

DocNumber

The number of the document of parents rights

String(20)

no

DocDeliver

The issued by of the document of parents rights

String(240)

Court name

no

DocDate

The issued date of the document of parents rights

String(10)

no

DocOpTypeId

Type of operation related
document

Number(8)

1 - Act record registration

4 - Changes

no

DocOpSubTypeId

Subtype of operation

Number(15)

no

AR_LIST (list of birth acts) example:

Marriage act records methods

GetMarriageArByRegDatePeriod

Name

Application software interface (service) for downloading data of marriage act records by registration date period

Service name

GetMarriageArByRegDatePeriod

Purpose

Get marriage act records data by registration date period

Subsystem identifier

3_MJU_DRACS_prod

Operating mode

Around the clock (24/7)

WSDL

Input params

Nesting level

Code

Description

Data type (according to XML specification)

Required

1

DateFrom

Start date of the period for which the marriage act records data is provided

xs:date

yes

1

DateTo

End date of the period for which the marriage act records data is provided

xs:date

yes

Request example:

 GetMarriageArByRegDatePeriod
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xro="http://x-road.eu/xsd/xroad.xsd" xmlns:iden="http://x-road.eu/xsd/identifiers" xmlns:tem="http://tempuri.org/">
   <soapenv:Header>
      <xro:client iden:objectType="SUBSYSTEM">
         <iden:xRoadInstance>SEVDEIR-TEST</iden:xRoadInstance>
         <iden:memberClass>GOV</iden:memberClass>
         <iden:memberCode>42032422</iden:memberCode>
         <iden:subsystemCode>50_eHealth_preprod_DRACS_Death_cons</iden:subsystemCode>
      </xro:client>
      <xro:service iden:objectType="SERVICE">
         <iden:xRoadInstance>SEVDEIR-TEST</iden:xRoadInstance>
         <iden:memberClass>GOV</iden:memberClass>
         <iden:memberCode>00015622</iden:memberCode>
         <iden:subsystemCode>3_MJU_DRACS_prod</iden:subsystemCode>
         <iden:serviceCode>GetMarriageArByRegDatePeriod</iden:serviceCode>
      </xro:service>
      <xro:userId>test</xro:userId>
      <xro:id>d6c38aa0-f392-4c52-a478-ffb41af61b6d</xro:id>
      <xro:protocolVersion>4.0</xro:protocolVersion>
   </soapenv:Header>
   <soapenv:Body>
      <tem:ArMarriageDivorceServiceRequest>
         <tem:DateFrom>2024-03-21</tem:DateFrom>
         <tem:DateTo>2024-03-21</tem:DateTo>
      </tem:ArMarriageDivorceServiceRequest>
   </soapenv:Body>
</soapenv:Envelope>

Response

Nesting level

Code

Description

Data type (according to XML specification)

Required

1

ResultCode

Result code of request

Values:

  • 0 - successfully completed;

  • 1 - internal error;

  • 2 - not allowed for this client;

  • 3 - more than one active service;

  • 4 - fields are not specified;

  • 5 - incorrect input parameters (validation failed)

xs:string

yes

1

ResultData

XML data with marriage act records details based on input params, encoded in Base64 (returned if ResultCode = 0)

XML file format is described in https://e-health-ua.atlassian.net/wiki/spaces/DRACS2/pages/17858101249#MarriageArResultData

xs:string

no

1

ErrorInfo

Error information (returned if ResultCode <> 0)

xs:string

no

MarriageArResultData

 MarriageArResultData

Code

Description

Type and length

Note

Required

Act record in registry details

ArRegDate

Act record date in registry

date

Date and time in 2019-03-26T00:00:00 format

yes

ArRegNumber

Act record number in registry

string(11)

Numbers only

yes

OP_DATE

Date of last operation with act record

date

Date and time in 2019-03-26T00:00:00 format

yes

AR_OP_NAME

Name of last operation with act record

number(2)

1 - Registration

2 - Removal

3 - Cancellation

4 - Changes

yes

RegNumb

Act record number in the book of state registration of marriages

string(18)

Numbers only

no

СomposeDate

Act record compose date

string(10)

 

no

ComposeOrg

The state organization that composed act record

string(240)

 

no

IS_RESTORE

Restored (renewed) flag

number(1)

0 - no

1 - yes

yes

Husband details

HusbandOld_Surname

Husbands surname before state marriage registration

string (50)

no

HusbandSurname

Husbands surname after state marriage registration

string (50)

no

HusbandName

Husbands first name

string (50)

no

HusbandPatronymic

Husbands secord name

string (50)

no

HusbandNumident

Husbands tax id

string (10)

no

HusbandDateBirth

Husbands birth date

String(10)

no

HusbandCitizenship

Husbands citizenship

Number(2)

82 - stateless person;

83 - male citizen of Ukraine;

84 - female citizen of Ukraine;

85 - other

no

HusbandCitizenshipAnother

Husbands another citizenship (set if HusbandCitizenship = 85)

string(240)

no

Husbands passport or passport document data

HusbandDocType

Husbands document type

String (2)

1 - Passport of a citizen of Ukraine;

2 - Diplomatic passport of Ukraine;

3 - Certificate of Ukrainian citizenship;

4 - Seaman's identity card;

5 - Identity card for return to Ukraine;

6 - Certificate of the crew member;

7 - Temporary certificate of a citizen of Ukraine;

8 - Another document;

9 - Service passport of Ukraine;

10 - Birth certificate;

no

HusbandDocName

Husbands personal document name

String (100)

no

HusbandSERIES_NUMB

Husbands personal document series and number

String (50)

no

HusbandDocDate

Husbands personal document issue date

String(10)

no

HusbandDocOrgName

Husbands personal document issuer name

String (256)

no

Husbands birthplace data

no

HusbandBirthState

Husbands birthplace country name

String (240)

no

HusbandBirthRegion

Husbands birthplace region name

String (120)

no

HusbandBirthDistrict

Husbands birthplace district name

String (120)

no

HusbandBirthLocalityType

Husbands birthplace locality type

String (1)

If exists - is provided according to dictionary.

Possible values: місто, район, селище міського типу, село, селище, сільрада, селищна рада

no

HusbandBirthLocality

Husbands birthplace locality name

String (120)

no

Husbands residence place data

no

HusbandState

Husbands residence country name

String (240)

no

HusbandRegion

Husbands residence region name

String (120)

no

HusbandDistrict

Husbands residence district name

String (120)

no

HusbandLocalityType

Husbands residence locality type

String (1)

If exists - is provided according to dictionary.

Possible values: місто, район, селище міського типу, село, селище, сільрада, селищна рада

no

HusbandLocality

Husbands residence locality name

String (120)

no

HusbandStreet

Husbands residence street name

String (120)

Includes street type

no

HusbandHouse

Husbands residence house number

String (25)

no

HusbandBuildingPart

Husbands residence building part type

String(25) 

1 - building (ua: корпус)

2 - section

no

HusbandBuildingPartType

Husbands residence building part

String(1)

no

HusbandApartment

Husbands residence apartment number

String (25)

no

Wife details

WifeOld_Surname

Wifes surname before state marriage registration

string (50)

no

WifeSurname

Wifes surname after state marriage registration

string (50)

no

WifeName

Wifes first name

string (50)

no

WifePatronymic

Wifes secord name

string (50)

no

WifeNumident

Wifes tax id

string (10)

no

WifeDateBirth

Wifes birth date

String(10)

no

WifeCitizenship

Wifes citizenship

Number(2)

82 - stateless person;

83 - male citizen of Ukraine;

84 - female citizen of Ukraine;

85 - other

no

WifeCitizenshipAnother

Wifes another citizenship (set if WifeCitizenship = 85)

string(240)

no

Wifes passport or passport document data

WifeDocType

Wifes document type

String (2)

1 - Passport of a citizen of Ukraine;

2 - Diplomatic passport of Ukraine;

3 - Certificate of Ukrainian citizenship;

4 - Seaman's identity card;

5 - Identity card for return to Ukraine;

6 - Certificate of the crew member;

7 - Temporary certificate of a citizen of Ukraine;

8 - Another document;

9 - Service passport of Ukraine;

10 - Birth certificate;

no

WifeDocName

Wifes personal document name

String (100)

no

WifeSERIES_NUMB

Wifes personal document series and number

String (50)

no

WifeDocDate

Wifes personal document issue date

String(10)

no

WifeDocOrgName

Wifes personal document issuer name

String (256)

no

Wifes birthplace data

no

WifeBirthState

Wifes birthplace country name

String (240)

no

WifeBirthRegion

Wifes birthplace region name

String (120)

no

WifeBirthDistrict

Wifes birthplace district name

String (120)

no

WifeBirthLocalityType

Wifes birthplace locality type

String (1)

If exists - is provided according to dictionary.

Possible values: місто, район, селище міського типу, село, селище, сільрада, селищна рада

no

WifeBirthLocality

Wifes birthplace locality name

String (120)

no

Wifes residence place data

no

WifeState

Wifes residence country name

String (240)

no

WifeRegion

Wifes residence region name

String (120)

no

WifeDistrict

Wifes residence district name

String (120)

no

WifeLocalityType

Wifes residence locality type

String (1)

If exists - is provided according to dictionary.

Possible values: місто, район, селище міського типу, село, селище, сільрада, селищна рада

no

WifeLocality

Wifes residence locality name

String (120)

no

WifeStreet

Wifes residence street name

String (120)

Includes street type

no

WifeHouse

Wifes residence house number

String (25)

no

WifeBuildingPart

Wifes residence building part type

String(25) 

1 - building (ua: корпус)

2 - section

no

WifeBuildingPartType

Wifes residence building part

String(1)

no

WifeApartment

Wifes residence apartment number

String (25)

no

Divorce act records methods

GetDivorceArByRegDatePeriod

Name

Application software interface (service) for downloading data of divorce act records by registration date period

Service name

GetDivorceArByRegDatePeriod

Purpose

Get divorce act records data by registration date period

Subsystem identifier

3_MJU_DRACS_prod

Operating mode

Around the clock (24/7)

WSDL

Input params

Nesting level

Code

Description

Data type (according to XML specification)

Required

1

DateFrom

Start date of the period for which the divorce act records data is provided

xs:date

yes

1

DateTo

End date of the period for which the divorce act records data is provided

xs:date

yes

Request example:

 GetDivorceArByRegDatePeriod
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xro="http://x-road.eu/xsd/xroad.xsd" xmlns:iden="http://x-road.eu/xsd/identifiers" xmlns:tem="http://tempuri.org/">
   <soapenv:Header>
      <xro:client iden:objectType="SUBSYSTEM">
         <iden:xRoadInstance>SEVDEIR-TEST</iden:xRoadInstance>
         <iden:memberClass>GOV</iden:memberClass>
         <iden:memberCode>42032422</iden:memberCode>
         <iden:subsystemCode>50_eHealth_preprod_DRACS_Death_cons</iden:subsystemCode>
      </xro:client>
      <xro:service iden:objectType="SERVICE">
         <iden:xRoadInstance>SEVDEIR-TEST</iden:xRoadInstance>
         <iden:memberClass>GOV</iden:memberClass>
         <iden:memberCode>00015622</iden:memberCode>
         <iden:subsystemCode>3_MJU_DRACS_prod</iden:subsystemCode>
         <iden:serviceCode>GetDivorceArByRegDatePeriod</iden:serviceCode>
      </xro:service>
      <xro:userId>test</xro:userId>
      <xro:id>d6c38aa0-f392-4c52-a478-ffb41af61b6d</xro:id>
      <xro:protocolVersion>4.0</xro:protocolVersion>
   </soapenv:Header>
   <soapenv:Body>
      <tem:ArMarriageDivorceServiceRequest>
         <tem:DateFrom>2024-03-21</tem:DateFrom>
         <tem:DateTo>2024-03-21</tem:DateTo>
      </tem:ArMarriageDivorceServiceRequest>
   </soapenv:Body>
</soapenv:Envelope>

Response

Nesting level

Code

Description

Data type (according to XML specification)

Required

1

ResultCode

Result code of request

Values:

  • 0 - successfully completed;

  • 1 - internal error;

  • 2 - not allowed for this client;

  • 3 - more than one active service;

  • 4 - fields are not specified;

  • 5 - incorrect input parameters (validation failed)

xs:string

yes

1

ResultData

XML data with divorce act records details based on input params, encoded in Base64 (returned if ResultCode = 0)

XML file format is described in https://e-health-ua.atlassian.net/wiki/spaces/DRACS2/pages/17858101249#DivorceArResultData

xs:string

no

1

ErrorInfo

Error information (returned if ResultCode <> 0)

xs:string

no

DivorceArResultData

 DivorceArResultData

Code

Description

Type and length

Note

Required

Act record in registry details

ArRegDate

Act record date in registry

date

Date and time in 2019-03-26T00:00:00 format

yes

ArRegNumber

Act record number in registry

string(11)

Numbers only

yes

OP_DATE

Date of last operation with act record

date

Date and time in 2019-03-26T00:00:00 format

yes

AR_OP_NAME

Name of last operation with act record

number(2)

1 - Registration

2 - Removal

3 - Cancellation

4 - Changes

yes

RegNumb

Act record number in the book of state registration of divorces

string(18)

Numbers only

no

СomposeDate

Act record compose date

string(10)

 

no

ComposeOrg

The state organization that composed act record

string(240)

 

no

IS_RESTORE

Restored (renewed) flag

number(1)

0 - no

1 - yes

yes

Husband details

MnOld_Surname

Husbands surname before state divorce registration

string (50)

no

MnSurname

Husbands surname after state divorce registration

string (50)

no

MnName

Husbands first name

string (50)

no

MnPatronymic

Husbands secord name

string (50)

no

MnNumident

Husbands tax id

string (10)

no

MnDateBirth

Husbands birth date

String(10)

no

MnCitizenship

Husbands citizenship

Number(2)

82 - stateless person;

83 - male citizen of Ukraine;

84 - female citizen of Ukraine;

85 - other

no

MnCitizenshipAnother

Husbands another citizenship (set if MnCitizenship = 85)

string(240)

no

Husbands passport or passport document data

MnDocType

Husbands document type

String (2)

1 - Passport of a citizen of Ukraine;

2 - Diplomatic passport of Ukraine;

3 - Certificate of Ukrainian citizenship;

4 - Seaman's identity card;

5 - Identity card for return to Ukraine;

6 - Certificate of the crew member;

7 - Temporary certificate of a citizen of Ukraine;

8 - Another document;

9 - Service passport of Ukraine;

10 - Birth certificate;

no

MnDocName

Husbands personal document name

String (100)

no

MnSERIES_NUMB

Husbands personal document series and number

String (50)

no

MnDocDate

Husbands personal document issue date

String(10)

no

MnDocOrgName

Husbands personal document issuer name

String (256)

no

Husbands birthplace data

no

MnBirthState

Husbands birthplace country name

String (240)

no

MnBirthRegion

Husbands birthplace region name

String (120)

no

MnBirthDistrict

Husbands birthplace district name

String (120)

no

MnBirthLocalityType

Husbands birthplace locality type

String (1)

If exists - is provided according to dictionary.

Possible values: місто, район, селище міського типу, село, селище, сільрада, селищна рада

no

MnBirthLocality

Husbands birthplace locality name

String (120)

no

Husbands residence place data

no

MnState

Husbands residence country name

String (240)

no

MnRegion

Husbands residence region name

String (120)

no

MnDistrict

Husbands residence district name

String (120)

no

MnLocalityType

Husbands residence locality type

String (1)

If exists - is provided according to dictionary.

Possible values: місто, район, селище міського типу, село, селище, сільрада, селищна рада

no

MnLocality

Husbands residence locality name

String (120)

no

MnStreet

Husbands residence street name

String (120)

Includes street type

no

MnHouse

Husbands residence house number

String (25)

no

MnBuildingPart

Husbands residence building part type

String(25) 

1 - building (ua: корпус)

2 - section

no

MnBuildingPartType

Husbands residence building part

String(1)

no

MnApartment

Husbands residence apartment number

String (25)

no

Wife details

WmnOld_Surname

Wifes surname before state divorce registration

string (50)

no

WmnSurname

Wifes surname after state divorce registration

string (50)

no

WmnName

Wifes first name

string (50)

no

WmnPatronymic

Wifes secord name

string (50)

no

WmnNumident

Wifes tax id

string (10)

no

WmnDateBirth

Wifes birth date

String(10)

no

WmnCitizenship

Wifes citizenship

Number(2)

82 - stateless person;

83 - male citizen of Ukraine;

84 - female citizen of Ukraine;

85 - other

no

WmnCitizenshipAnother

Wifes another citizenship (set if WmnCitizenship = 85)

string(240)

no

Wifes passport or passport document data

WmnDocType

Wifes document type

String (2)

1 - Passport of a citizen of Ukraine;

2 - Diplomatic passport of Ukraine;

3 - Certificate of Ukrainian citizenship;

4 - Seaman's identity card;

5 - Identity card for return to Ukraine;

6 - Certificate of the crew member;

7 - Temporary certificate of a citizen of Ukraine;

8 - Another document;

9 - Service passport of Ukraine;

10 - Birth certificate;

no

WmnDocName

Wifes personal document name

String (100)

no

WmnSERIES_NUMB

Wifes personal document series and number

String (50)

no

WmnDocDate

Wifes personal document issue date

String(10)

no

WmnDocOrgName

Wifes personal document issuer name

String (256)

no

Wifes birthplace data

no

WmnBirthState

Wifes birthplace country name

String (240)

no

WmnBirthRegion

Wifes birthplace region name

String (120)

no

WmnBirthDistrict

Wifes birthplace district name

String (120)

no

WmnBirthLocalityType

Wifes birthplace locality type

String (1)

If exists - is provided according to dictionary.

Possible values: місто, район, селище міського типу, село, селище, сільрада, селищна рада

no

WmnBirthLocality

Wifes birthplace locality name

String (120)

no

Wifes residence place data

no

WmnState

Wifes residence country name

String (240)

no

WmnRegion

Wifes residence region name

String (120)

no

WmnDistrict

Wifes residence district name

String (120)

no

WmnLocalityType

Wifes residence locality type

String (1)

If exists - is provided according to dictionary.

Possible values: місто, район, селище міського типу, село, селище, сільрада, селищна рада

no

WmnLocality

Wifes residence locality name

String (120)

no

WmnStreet

Wifes residence street name

String (120)

Includes street type

no

WmnHouse

Wifes residence house number

String (25)

no

WmnBuildingPart

Wifes residence building part type

String(25) 

1 - building (ua: корпус)

2 - section

no

WmnBuildingPartType

Wifes residence building part

String(1)

no

WmnApartment

Wifes residence apartment number

String (25)

no

Change name act records methods

GetChangeNameArByRegDatePeriod

Name

Application software interface (service) for downloading data of name change act records by registration date period

Service name

GetChangeNameArByRegDatePeriod

Purpose

Get name change act records data by registration date period

Subsystem identifier

3_MJU_DRACS_prod

Operating mode

Around the clock (24/7)

WSDL

Input params

Nesting level

Code

Description

Data type (according to XML specification)

Required

1

DateFrom

Start date of the period for which the name change act records data is provided

xs:date

yes

1

DateTo

End date of the period for which the name change act records data is provided

xs:date

yes

Request example:

 GetChangeNameArByRegDatePeriod
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xro="http://x-road.eu/xsd/xroad.xsd" xmlns:iden="http://x-road.eu/xsd/identifiers" xmlns:tem="http://tempuri.org/">
   <soapenv:Header>
      <xro:client iden:objectType="SUBSYSTEM">
         <iden:xRoadInstance>SEVDEIR-TEST</iden:xRoadInstance>
         <iden:memberClass>GOV</iden:memberClass>
         <iden:memberCode>42032422</iden:memberCode>
         <iden:subsystemCode>50_eHealth_preprod_DRACS_Death_cons</iden:subsystemCode>
      </xro:client>
      <xro:service iden:objectType="SERVICE">
         <iden:xRoadInstance>SEVDEIR-TEST</iden:xRoadInstance>
         <iden:memberClass>GOV</iden:memberClass>
         <iden:memberCode>00015622</iden:memberCode>
         <iden:subsystemCode>3_MJU_DRACS_prod</iden:subsystemCode>
         <iden:serviceCode>GetChangeNameArByRegDatePeriod</iden:serviceCode>
      </xro:service>
      <xro:userId>test</xro:userId>
      <xro:id>d6c38aa0-f392-4c52-a478-ffb41af61b6d</xro:id>
      <xro:protocolVersion>4.0</xro:protocolVersion>
   </soapenv:Header>
   <soapenv:Body>
      <tem:ArChangeNameServiceRequest>
         <tem:DateFrom>2024-03-21</tem:DateFrom>
         <tem:DateTo>2024-03-21</tem:DateTo>
      </tem:ArChangeNameServiceRequest>
   </soapenv:Body>
</soapenv:Envelope>

Response

Nesting level

Code

Description

Data type (according to XML specification)

Required

1

ResultCode

Result code of request

Values:

  • 0 - successfully completed;

  • 1 - internal error;

  • 2 - not allowed for this client;

  • 3 - more than one active service;

  • 4 - fields are not specified;

  • 5 - incorrect input parameters (validation failed)

xs:string

yes

1

ResultData

XML data with name change act records details based on input params, encoded in Base64 (returned if ResultCode = 0)

XML file format is described in https://e-health-ua.atlassian.net/wiki/spaces/DRACS2/pages/17858101249#ChangeNameArResultData

xs:string

no

1

ErrorInfo

Error information (returned if ResultCode <> 0)

xs:string

no

ChangeNameArResultData

Note: this is not a final response description, as no actual description for service was provided.

 ChangeNameArResultData

Code

Description

Type and length

Note

Required

Act record in registry details

ArRegDate

Act record date in registry

date

Date and time in 2019-03-26T00:00:00 format

yes

ArRegNumber

Act record number in registry

string(11)

Numbers only

yes

OP_DATE

Date of last operation with act record

date

Date and time in 2019-03-26T00:00:00 format

yes

AR_OP_NAME

Name of last operation with act record

number(2)

1 - Registration

2 - Removal

3 - Cancellation

4 - Changes

yes

RegNumb

Act record number in the book of state registration of name changes

string(18)

Numbers only

no

СomposeDate

Act record compose date

string(10)

 

no

ComposeOrg

The state organization that composed act record

string(240)

 

no

IS_RESTORE

Restored (renewed) flag

number(1)

0 - no

1 - yes

yes

Person details

Old_Surname

Persons surname before name change registration

string (50)

yes

Old_Name

Persons first name before name change registration

string (50)

yes

Old_Patronymic

Persons second name before name change registration

string (50)

yes

New_Surname

Persons surname after name change registration

string (50)

yes

New_Name

Persons first name after name change registration

string (50)

yes

New_Patronymic

Persons second name after name change registration

string (50)

yes

Numident

Persons tax id

string (10)

no

DateBirth

Persons birth date

String(10)

no

Sex

Persons gender

string(1)

1 - male

2 - female

yes

Citizenship

Persons citizenship

Number(2)

82 - stateless person;

83 - male citizen of Ukraine;

84 - female citizen of Ukraine;

85 - other

no

CitizenshipAnother

Persons another citizenship (set if Citizenship = 85)

string(240)

no

Persons passport or passport document data

DocType

Persons document type

String (2)

1 - Passport of a citizen of Ukraine;

2 - Diplomatic passport of Ukraine;

3 - Certificate of Ukrainian citizenship;

4 - Seaman's identity card;

5 - Identity card for return to Ukraine;

6 - Certificate of the crew member;

7 - Temporary certificate of a citizen of Ukraine;

8 - Another document;

9 - Service passport of Ukraine;

10 - Birth certificate;

no

DocName

Persons personal document name

String (100)

no

SERIES_NUMB

Persons personal document series and number

String (50)

no

DocDate

Persons personal document issue date

String(10)

no

DocOrgName

Persons personal document issuer name

String (256)

no

Persons birthplace data

no

BirthState

Persons birthplace country name

String (240)

no

BirthRegion

Persons birthplace region name

String (120)

no

BirthDistrict

Persons birthplace district name

String (120)

no

BirthLocalityType

Persons birthplace locality type

String (1)

If exists - is provided according to dictionary.

Possible values: місто, район, селище міського типу, село, селище, сільрада, селищна рада

no

BirthLocality

Persons birthplace locality name

String (120)

no

Persons residence place data

no

State

Persons residence country name

String (240)

no

Region

Persons residence region name

String (120)

no

District

Persons residence district name

String (120)

no

LocalityType

Persons residence locality type

String (1)

If exists - is provided according to dictionary.

Possible values: місто, район, селище міського типу, село, селище, сільрада, селищна рада

no

Locality

Persons residence locality name

String (120)

no

Street

Persons residence street name

String (120)

Includes street type

no

House

Persons residence house number

String (25)

no

BuildingPart

Persons residence building part type

String(25) 

1 - building (ua: корпус)

2 - section

no

BuildingPartType

Persons residence building part

String(1)

no

Apartment

Persons residence apartment number

String (25)

no

Marriage and divorce certificates methods

GetCertByNumRoleNames

Name

Application software interface (service) for downloading data of marriage and divorce certificates by serial number, act record type, role and full name

Service name

GetCertByNumRoleNames

Purpose

Get certificate data by serial number, act record type, role and full name

Subsystem identifier

3_MJU_DRACS_prod

Operating mode

Around the clock (24/7)

WSDL

Input params

Nesting level

Code

Description

Data type (according to XML specification)

Required

1

ByParam

Act record type (4 - marriage, 5 - divorce)

xs:string

yes

1

CertNumber

Certificate number

xs:string

yes

1

CertSerial

Certificate serial

xs:string

yes

1

Name

Persons name

xs:string

yes

1

Patronymic

Persons second name

xs:string

yes

1

Role

Persons role in certificate (2 - wife for marriage cert, 3 - husband for marriage cert, 5 - husband for divorce cert, 6 - wife for marriage cert)

xs:string

yes

1

Surname

Persons last name

xs:string

yes

Request example:

 GetCertByNumRoleNames
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xro="http://x-road.eu/xsd/xroad.xsd" xmlns:iden="http://x-road.eu/xsd/identifiers" xmlns:tem="http://tempuri.org/">
   <soapenv:Header>
      <xro:client iden:objectType="SUBSYSTEM">
         <iden:xRoadInstance>SEVDEIR-TEST</iden:xRoadInstance>
         <iden:memberClass>GOV</iden:memberClass>
         <iden:memberCode>42032422</iden:memberCode>
         <iden:subsystemCode>50_eHealth_preprod_DRACS_Death_cons</iden:subsystemCode>
      </xro:client>
      <xro:service iden:objectType="SERVICE">
         <iden:xRoadInstance>SEVDEIR-TEST</iden:xRoadInstance>
         <iden:memberClass>GOV</iden:memberClass>
         <iden:memberCode>00015622</iden:memberCode>
         <iden:subsystemCode>3_MJU_DRACS_prod</iden:subsystemCode>
         <iden:serviceCode>GetCertByNumRoleNames</iden:serviceCode>
      </xro:service>
      <xro:userId>test</xro:userId>
      <xro:id>d6c38aa0-f392-4c52-a478-ffb41af61b6d</xro:id>
      <xro:protocolVersion>4.0</xro:protocolVersion>
   </soapenv:Header>
   <soapenv:Body>
      <tem:CeServiceRequest>
         <tem:ByParam>4</tem:ByParam>
         <tem:CertNumber>234123124</tem:CertNumber>
         <tem:CertSerial>ІКП-Е</tem:CertSerial>
         <tem:Name>Іванна</tem:Name>
         <tem:Patronymic>Юріївна</tem:Patronymic>
         <tem:Role>2</tem:Role>
         <tem:Surname>Михайличук</tem:Surname>
      </tem:CeServiceRequest>
   </soapenv:Body>
</soapenv:Envelope>

Response

Nesting level

Code

Description

Data type (according to XML specification)

Required

1

ResultCode

Result code of request

Values:

  • 0 - successfully completed;

  • 1 - internal error;

  • 2 - not allowed for this client;

  • 3 - more than one active service;

  • 4 - fields are not specified;

  • 5 - incorrect input parameters (validation failed)

xs:string

yes

1

ResultData

XML data with certificate records details based on input params, encoded in Base64 (returned if ResultCode = 0)

XML file format is described in https://e-health-ua.atlassian.net/wiki/spaces/DRACS2/pages/17858101249/UPD+DRACS+Trembita+methods_EN#CertResultData

xs:string

no

1

ErrorInfo

Error information (returned if ResultCode <> 0)

xs:string

no

CertResultData

 MarriageCertResultData

Code

Description

Type and length

Note

Required

CertStatus

Marriage certificate status

Number (1)

1 - active

3 - canceled

yes

CertRepeat

Repeated (renewed) flag

0 - no

1 - yes

Number (1)

0 - no

1 - yes

no

CertSerial

Marriage certificate serial (first symbols of serial number, up to 11)

String(10)

yes

CertNumber

Marriage certificate number (last digits of serial number, up to 10)

String(11)

yes

CertSerialNumber 

Marriage certificate serial number

string (21)

CertSerial + CertNumber

yes 

CertOrg

The state organization who composed marriage certificate

String(240)

yes

CertDate

Marriage certificate compose date

String(10)

yes

ArOrg

Place of act record registration

String(240)

no

AR_NUMB

Number of act record registration

String(18)

no

AR_COMPOSEDATE

Date of act record registration

String(10)

no

HusbandOld_Surname

Husbands last name before state marriage registration

String(50)

yes

HusbandSurname

Husbands last name after state marriage registration

String(50)

yes

HusbandName

Husbands first name

String(50)

yes

HusbandPatronymic

Husbands secord name

String(50)

no

HusbandCitizenship

Husbands citizenship

Number(2)  

82 - stateless person;

83 - male citizen of Ukraine;

84 - female citizen of Ukraine;

85 - other

no

HusbandCitizenshipAnother

Husbands another citizenship (set if husband_citizenship = 85)

String(240)

no

HusbandBirthdate

Husbands birth date

String(10)

yes

HusbandPlaceofBirth

Husbands birth place

String(10)

no

WifeOld_Surname

Wifes last name before state marriage registration

String(50)

yes

WifeSurname

Wifes last name after state marriage registration

String(50)

yes

WifeName

Wifes first name

String(50)

yes

WifePatronymic

Wifes secord name

String(50)

no

WifeCitizenship

Wifes citizenship

Number(2)  

82 - stateless person;

83 - male citizen of Ukraine;

84 - female citizen of Ukraine;

85 - other

no

WifeCitizenshipAnother

Wifes another citizenship (set if husband_citizenship = 85)

String(240)

no

WifeBirthdate

Wifes birth date

String(50)

yes

WifePlaceofBirth

Wifes birth place

string

no

 DivorceCertResultData

Code

Description

Type and length

Note

Required

CertStatus

Divorce certificate status

Number (1)

1 - active

3 - canceled

yes

CertRepeat

Repeated (renewed) flag

0 - no

1 - yes

Number (1)

0 - no

1 - yes

no

CertSerial

Divorce certificate serial (first symbols of serial number, up to 11)

String(10)

yes

CertNumber

Divorce certificate number (last digits of serial number, up to 10)

String(11)

yes

CertSerialNumber 

Divorce certificate serial number

string (21)

CertSerial + CertNumber

yes 

CertOrg

The state organization who composed divorcec certificate

String(240)

yes

CertDate

Divorce certificate compose date

String(10)

yes

Receiver

Received of the divorce certificate

String(240)

no

ArOrg

Place of act record registration

String(240)

no

AR_NUMB

Number of act record registration

String(18)

no

AR_COMPOSEDATE

Date of act record registration

String(10)

no

HusbandOld_Surname

Husbands last name before state divorce registration

String(50)

yes

HusbandSurname

Husbands last name after state divorce registration

String(50)

yes

HusbandName

Husbands first name

String(50)

yes

HusbandPatronymic

Husbands secord name

String(50)

no

WifeOld_Surname

Wifes last name before state divorce registration

String(50)

yes

WifeSurname

Wifes last name after state divorce registration

String(50)

yes

WifeName

Wifes first name

String(50)

yes

WifePatronymic

Wifes secord name

String(50)

no

  • No labels

ЕСОЗ - публічна документація