View personal data of the User
Returns data of the Person of the requesting User.
Endpoint
Request Type | URL |
|---|---|
GET | https://{EnvironmentURL}/kycp/persons |
Headers
Parameter | Type | Mandatory | Description |
|---|---|---|---|
x-api-version | string | Yes | 1.0 |
Request parameters
No parameters
Responses
200 OK - Success
Body – JSON, Personal data of the current User
Parameter | Type | Mandatory | Description |
|---|---|---|---|
id | string | Mandatory | Identifier, guid |
givenName | string | Mandatory | First name of the Person |
surname | string | Mandatory | Last name of the Person |
middleName | string | Non mandatory | Middle name of the Person if exists |
dateOfBirth | string | Mandatory | Date in format YYYY-MM-DD |
dateOfDeath | string | Non mandatory | Date in format YYYY-MM-DD |
countryOfBirthExtId | string | Mandatory | Identifier from Countries lookup. LookupId = 4 |
countryOfBirth | string | Yes | ISO 2-letters Code of the country |
countryOfBirthName | string | Yes | Name of the country |
string | Mandatory | Email address of the Person | |
phone | string | Mandatory | Mobile phone number of the Person |
genderExtId | int | Mandatory | Identifier from Genders lookup. LookupId = 2 |
gender | string | Mandatory | Name of the Gender |
address | Location | Non mandatory | Residence address of the Person |
Location - object
Parameter | Type | Mandatory | Description |
|---|---|---|---|
id | string | Yes | Identifier, guid |
country | string | Yes | ISO 2-letters Code of the country |
countryName | string | Yes | Name of the country |
countryExtId | int | Yes | Identifier from Countries lookup, Id = 4 |
state | string | No | State for Countries where applicable |
city | string | Yes | City name |
street | string | Yes | Street name |
building | string | Yes | Building name/number |
postCode | string | Yes | Postcode |
404 - Not found
Personal data of User are not filled
Body - JSON
Standard Problem details object
401 - Unauthorized
No Body