1 Purpose
- 1.1 DRACS envelope headers
- 1.2 Death act records methods
  - 1.2.1 GetDeathArByRegDatePeriod
    - 1.2.1.1 Input params
    - 1.2.1.2 Response
  - 1.2.2 GetDeathArByFullNameAndBirthDate
    - 1.2.2.1 Input params
    - 1.2.2.2 Response
  - 1.2.3 DeathArResultData
- 1.3 Birth act records methods
  - 1.3.1 GetBirthArByChildNameAndBirthDate
    - 1.3.1.1 Input params
    - 1.3.1.2 Response
  - 1.3.2 BirthArResultData
- 1.4 Marriage act records methods
  - 1.4.1 GetMarriageArByRegDatePeriod
    - 1.4.1.1 Input params
    - 1.4.1.2 Response
  - 1.4.2 MarriageArResultData
- 1.5 Divorce act records methods
  - 1.5.1 GetDivorceArByRegDatePeriod
    - 1.5.1.1 Input params
    - 1.5.1.2 Response
  - 1.5.2 DivorceArResultData
- 1.6 Change name act records methods
  - 1.6.1 GetChangeNameArByRegDatePeriod
    - 1.6.1.1 Input params
    - 1.6.1.2 Response
  - 1.6.2 ChangeNameArResultData
- 1.7 Marriage and divorce certificates methods
  - 1.7.1 GetCertByNumRoleNames
    - 1.7.1.1 Input params
    - 1.7.1.2 Response
  - 1.7.2 CertResultData

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: RC_Third-party registries configurable parameters_ph2 (DRACS 2.0)

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

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:

<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

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

RC_DRACS Trembita methods_ph2 (DRACS 2.0) | DeathArResultData

xs:string

no

1

ErrorInfo

Error information (returned if ResultCode <> 0)

xs:string

no

Response example (success):

<?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):

<?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

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:

Response

Nesting level	Code	Description	Data type (according to XML specification)	Required

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

RC_DRACS Trembita methods_ph2 (DRACS 2.0) | DeathArResultData

xs:string

no

1

ErrorInfo

Error information (returned if ResultCode <> 0)

xs:string

no

Response example (success):

Response example (error):

DeathArResultData

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

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

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:

Response

Nesting level	Code	Description	Data type (according to XML specification)	Required

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

RC_DRACS Trembita methods (DRACS 2.0) | BirthArResultData

xs:string

no

1

ErrorInfo

Error information (returned if ResultCode <> 0)

xs:string

no

Response example (success):

BirthArResultData

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

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:

Response

Nesting level	Code	Description	Data type (according to XML specification)	Required

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 RC_DRACS Trembita methods (DRACS 2.0) | MarriageArResultData

xs:string

no

1

ErrorInfo

Error information (returned if ResultCode <> 0)

xs:string

no

MarriageArResultData

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

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:

Response

Nesting level	Code	Description	Data type (according to XML specification)	Required

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 RC_DRACS Trembita methods (DRACS 2.0) | DivorceArResultData

xs:string

no

1

ErrorInfo

Error information (returned if ResultCode <> 0)

xs:string

no

DivorceArResultData

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

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:

Response

Nesting level	Code	Description	Data type (according to XML specification)	Required

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

RC_DRACS Trembita methods (DRACS 2.0) | 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.

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

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:

Response

Nesting level	Code	Description	Data type (according to XML specification)	Required

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 RC_DRACS Trembita methods (DRACS 2.0) | CertResultData

xs:string

no

1

ErrorInfo

Error information (returned if ResultCode <> 0)

xs:string

no