identities

Operations addressed under /identities — 5 operations.

get-person-address

GET

https://dg-sandbox.dgpays.com/integration-service

/identities/person-addresses

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Invokes the get-person-address service definition through GET /identities/person-addresses.

Response body, read from the service source

The route declares its response as ExternalServiceResultDto<PersonAddressDto>.

Field	Declared type	Nullable
`Citizenid`	`string`	no
`BirthDate`	`DateOnly?`	yes
`AddressType`	`int?`	yes
`AddressSource`	`int?`	yes
`AddressOpenText`	`string`	no
`ForeignAddress`	`string`	no
`CountryId`	`int?`	yes
`Country`	`string`	no
`RegionCode`	`string`	no
`Region`	`string`	no
`CityCode`	`string`	no
`City`	`string`	no
`DistrictCode`	`string`	no
`District`	`string`	no
`NeihgbourhoodCode`	`string`	no
`Neihgbourhood`	`string`	no
`StreetCode`	`string`	no
`Street`	`string`	no
`BuildingCode`	`string`	no
`Building`	`string`	no
`SectionCode`	`string`	no
`Section`	`string`	no
`AddressNumber`	`string`	no
`CreatedDate`	`DateTime`	no

Member names are the service's declaration names.

get-person-address › query Parameters

birthDate

string · date · required

citizenNumber

string · required

queryType

integer · int32 · required

queryDayNumber

integer · int32

get-person-address › Responses

Success. An exact, uniquely bound route registration classifies this response as a single-record.

No data returned

get-person-info-changed

GET

https://dg-sandbox.dgpays.com/integration-service

/identities/person-info-changes

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

get-person-info-changed › query Parameters

changeType

integer · int32

citizenNumber

string[]

endDate

string · date

pageNumber

integer · int64

startDate

string · date-time

get-person-info-changed › Responses

Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.

object[]

Array of catalog-declared response records.

object

externalServiceResultId

string · uuid

get-person-info

GET

https://dg-sandbox.dgpays.com/integration-service

/identities/person-infos

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

get-person-info › query Parameters

birthDate

string · date

citizenNumber

integer · int64

get-person-info › Responses

Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.

object

externalServiceResultId

string · uuid

GET/identities/person-infos

curl https://dg-sandbox.dgpays.com/integration-service/identities/person-infos

Example Responses

{
  "externalServiceResult": {
    "binder": "binder",
    "binderCode": 0,
    "birthDate": "2024-08-25",
    "birthPlace": "birthPlace",
    "birthPlaceCode": 0,
    "citizenNumber": 0,
    "citizenNumberTypeCode": 0,
    "country": "country",
    "countryCode": 0,
    "deathDate": "2024-08-25T15:00:00Z",
    "familyRecordNo": {},
    "fatherName": "fatherName",
    "gender": "gender",
    "genderCode": 0,
    "identityCardNo": 0,
    "identityCardSerialNo": "identityCardSerialNo",
    "issueDate": "2024-08-25T15:00:00Z",
    "issueOffice": "issueOffice",
    "issueReason": "issueReason",
    "maritalStatus": "maritalStatus",
    "maritalStatusCode": 0,
    "middleName": "middleName",
    "motherName": "motherName",
    "name": "name",
    "nationality": "nationality",
    "nationalityCode": 0,
    "personRecordNo": 0,
    "previousSurname": "previousSurname",
    "recordNo": 0,
    "registerCity": {},
    "registerCityCode": 0,
    "registerDistinct": "registerDistinct",
    "registerDistinctCode": 0,
    "status": "status",
    "statusCode": 0,
    "surName": "surName",
    "validityDate": "2024-08-25T15:00:00Z"
  },
  "externalServiceResultId": "00000000-0000-0000-0000-000000000000"
}

json

application/json

get-person-registration-changed

GET

https://dg-sandbox.dgpays.com/integration-service

/identities/person-registration-changes

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Invokes the get-person-registration-changed service definition through GET /identities/person-registration-changes.

Response body, read from the service source

The route declares its response as ExternalServiceResultDto<PersonRegistrationChangedDto>.

Field	Declared type	Nullable
`PersonRegistrationChangeds`	`List<PersonChanged>` (collection)	no

Member names are the service's declaration names.

get-person-registration-changed › query Parameters

changedType

string

citizenids

integer[]

endDate

string · date

pageNumber

integer · int64

startDate

string · date

get-person-registration-changed › Responses

Success. An exact, uniquely bound route registration classifies this response as a single-record.

No data returned

get-person-registration

GET

https://dg-sandbox.dgpays.com/integration-service

/identities/person-registrations

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Invokes the get-person-registration service definition through GET /identities/person-registrations.

Response body, read from the service source

The route declares its response as ExternalServiceResultDto<PersonRegistrationDto>.

Field	Declared type	Nullable
`RegistrationType`	`int?`	yes
`Name`	`string`	no
`Surname`	`string`	no
`MotherName`	`string`	no
`FatherName`	`string`	no
`Gender`	`int?`	yes
`MaritalStatus`	`int?`	yes
`PreviousSurname`	`string`	no
`Citizenid`	`string`	no
`BirthDate`	`DateOnly?`	yes
`BirthPlace`	`string`	no
`MotherCitizenid`	`string`	no
`FatherCitizenid`	`string`	no
`SpouseCitizenid`	`string`	no
`CountryId`	`int?`	yes
`Status`	`int?`	yes
`PreviousCitizenid`	`string`	no
`DeathDate`	`DateOnly?`	yes
`Nationality`	`int?`	yes
`IdentityCardType`	`int?`	yes
`IsTemporary`	`bool?`	yes
`RegistrationNumber`	`string`	no
`SerialNumber`	`string`	no
`IssueReason`	`string`	no
`IssueDate`	`DateOnly?`	yes
`IssueOffice`	`string`	no
`ValidityDate`	`DateOnly?`	yes
`ForeignPermissionStartDate`	`DateOnly?`	yes
`ForeignPermissionEndDate`	`DateOnly?`	yes
`ForeignPermissionNumber`	`string`	no
`ForeignPermissionCity`	`string`	no
`Unit`	`string`	no
`FamilyRecordNo`	`string`	no
`PersonRecordNo`	`string`	no
`Binder`	`string`	no
`RegisterCity`	`string`	no
`RegisterDistrict`	`string`	no
`Correlationid`	`Guid?`	yes
`HasGuardian`	`bool?`	yes
`GuardianshipType`	`int?`	yes

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_INTGRTN_64`	400	`KPS_SERVICE_REQUEST_ERROR`	Kps Service Request Error `{0}`

get-person-registration › query Parameters

birthDate

string · date · required

citizenNumber

string · required

queryType

integer · int32 · required

queryDayNumber

integer · int32

get-person-registration › Responses

Success. An exact, uniquely bound route registration classifies this response as a single-record.

No data returned

ibans instant-payment

Integration Service

identities

Operations addressed under /identities — 5 operations.

get-person-address

GET

https://dg-sandbox.dgpays.com/integration-service

/identities/person-addresses

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Invokes the get-person-address service definition through GET /identities/person-addresses.

Response body, read from the service source

The route declares its response as ExternalServiceResultDto<PersonAddressDto>.

Field	Declared type	Nullable
`Citizenid`	`string`	no
`BirthDate`	`DateOnly?`	yes
`AddressType`	`int?`	yes
`AddressSource`	`int?`	yes
`AddressOpenText`	`string`	no
`ForeignAddress`	`string`	no
`CountryId`	`int?`	yes
`Country`	`string`	no
`RegionCode`	`string`	no
`Region`	`string`	no
`CityCode`	`string`	no
`City`	`string`	no
`DistrictCode`	`string`	no
`District`	`string`	no
`NeihgbourhoodCode`	`string`	no
`Neihgbourhood`	`string`	no
`StreetCode`	`string`	no
`Street`	`string`	no
`BuildingCode`	`string`	no
`Building`	`string`	no
`SectionCode`	`string`	no
`Section`	`string`	no
`AddressNumber`	`string`	no
`CreatedDate`	`DateTime`	no

Member names are the service's declaration names.

get-person-address › query Parameters

birthDate

string · date · required

citizenNumber

string · required

queryType

integer · int32 · required

queryDayNumber

integer · int32

get-person-address › Responses

Success. An exact, uniquely bound route registration classifies this response as a single-record.

No data returned

get-person-info-changed

GET

https://dg-sandbox.dgpays.com/integration-service

/identities/person-info-changes

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

get-person-info-changed › query Parameters

changeType

integer · int32

citizenNumber

string[]

endDate

string · date

pageNumber

integer · int64

startDate

string · date-time

get-person-info-changed › Responses

object[]

Array of catalog-declared response records.

object

externalServiceResultId

string · uuid

get-person-info

GET

https://dg-sandbox.dgpays.com/integration-service

/identities/person-infos

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

get-person-info › query Parameters

birthDate

string · date

citizenNumber

integer · int64

get-person-info › Responses

object

externalServiceResultId

string · uuid

GET/identities/person-infos

curl https://dg-sandbox.dgpays.com/integration-service/identities/person-infos

Example Responses

{
  "externalServiceResult": {
    "binder": "binder",
    "binderCode": 0,
    "birthDate": "2024-08-25",
    "birthPlace": "birthPlace",
    "birthPlaceCode": 0,
    "citizenNumber": 0,
    "citizenNumberTypeCode": 0,
    "country": "country",
    "countryCode": 0,
    "deathDate": "2024-08-25T15:00:00Z",
    "familyRecordNo": {},
    "fatherName": "fatherName",
    "gender": "gender",
    "genderCode": 0,
    "identityCardNo": 0,
    "identityCardSerialNo": "identityCardSerialNo",
    "issueDate": "2024-08-25T15:00:00Z",
    "issueOffice": "issueOffice",
    "issueReason": "issueReason",
    "maritalStatus": "maritalStatus",
    "maritalStatusCode": 0,
    "middleName": "middleName",
    "motherName": "motherName",
    "name": "name",
    "nationality": "nationality",
    "nationalityCode": 0,
    "personRecordNo": 0,
    "previousSurname": "previousSurname",
    "recordNo": 0,
    "registerCity": {},
    "registerCityCode": 0,
    "registerDistinct": "registerDistinct",
    "registerDistinctCode": 0,
    "status": "status",
    "statusCode": 0,
    "surName": "surName",
    "validityDate": "2024-08-25T15:00:00Z"
  },
  "externalServiceResultId": "00000000-0000-0000-0000-000000000000"
}

json

application/json

get-person-registration-changed

GET

https://dg-sandbox.dgpays.com/integration-service

/identities/person-registration-changes

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Invokes the get-person-registration-changed service definition through GET /identities/person-registration-changes.

Response body, read from the service source

The route declares its response as ExternalServiceResultDto<PersonRegistrationChangedDto>.

Field	Declared type	Nullable
`PersonRegistrationChangeds`	`List<PersonChanged>` (collection)	no

Member names are the service's declaration names.

get-person-registration-changed › query Parameters

changedType

string

citizenids

integer[]

endDate

string · date

pageNumber

integer · int64

startDate

string · date

get-person-registration-changed › Responses

Success. An exact, uniquely bound route registration classifies this response as a single-record.

No data returned

get-person-registration

GET

https://dg-sandbox.dgpays.com/integration-service

/identities/person-registrations

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Invokes the get-person-registration service definition through GET /identities/person-registrations.

Response body, read from the service source

The route declares its response as ExternalServiceResultDto<PersonRegistrationDto>.

Field	Declared type	Nullable
`RegistrationType`	`int?`	yes
`Name`	`string`	no
`Surname`	`string`	no
`MotherName`	`string`	no
`FatherName`	`string`	no
`Gender`	`int?`	yes
`MaritalStatus`	`int?`	yes
`PreviousSurname`	`string`	no
`Citizenid`	`string`	no
`BirthDate`	`DateOnly?`	yes
`BirthPlace`	`string`	no
`MotherCitizenid`	`string`	no
`FatherCitizenid`	`string`	no
`SpouseCitizenid`	`string`	no
`CountryId`	`int?`	yes
`Status`	`int?`	yes
`PreviousCitizenid`	`string`	no
`DeathDate`	`DateOnly?`	yes
`Nationality`	`int?`	yes
`IdentityCardType`	`int?`	yes
`IsTemporary`	`bool?`	yes
`RegistrationNumber`	`string`	no
`SerialNumber`	`string`	no
`IssueReason`	`string`	no
`IssueDate`	`DateOnly?`	yes
`IssueOffice`	`string`	no
`ValidityDate`	`DateOnly?`	yes
`ForeignPermissionStartDate`	`DateOnly?`	yes
`ForeignPermissionEndDate`	`DateOnly?`	yes
`ForeignPermissionNumber`	`string`	no
`ForeignPermissionCity`	`string`	no
`Unit`	`string`	no
`FamilyRecordNo`	`string`	no
`PersonRecordNo`	`string`	no
`Binder`	`string`	no
`RegisterCity`	`string`	no
`RegisterDistrict`	`string`	no
`Correlationid`	`Guid?`	yes
`HasGuardian`	`bool?`	yes
`GuardianshipType`	`int?`	yes

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_INTGRTN_64`	400	`KPS_SERVICE_REQUEST_ERROR`	Kps Service Request Error `{0}`

get-person-registration › query Parameters

birthDate

string · date · required

citizenNumber

string · required

queryType

integer · int32 · required

queryDayNumber

integer · int32

get-person-registration › Responses

Success. An exact, uniquely bound route registration classifies this response as a single-record.

No data returned

ibans instant-payment