Help Instance Help

Add personal data for the User

Adds data of the Person to the requesting User. This information will be used in following Payments.

Endpoint

Request Type

URL

POST

https://{EnvironmentURL}/kycp/persons

Headers

Parameter

Type

Mandatory

Description

x-api-version

string

Yes

1.0

Request body

Body - JSON

Parameter

Type

Mandatory

Description

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

email

string

Mandatory

Email address of the Person

phone

string

Mandatory

Mobile phone number of the Person

gender

string

Mandatory

Identifier from Genders lookup. LookupId = 2

address

Location

Non mandatory

Residence address of the Person

Location - object

Parameter

Type

Mandatory

Description

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

Responses

Success

Body - JSON

Parameter

Type

Mandatory

Description

Person

object

Yes

Created Person object. Identifier + all fields from Request

400 - Bad Request

Personal data of User already filled

Body - JSON

Standard Problem details object

401 - Unauthorized

No Body

Last modified: 19 января 2024