Create person

post

https://apim.demo01.my.fivedegrees.cloud/publicapi-sbx/api/v1/persons

API endpoint to create a person. Depending on the configuration fields are optional or mandatory.

Body Params

Create person request

Model for creating new person

firstName

string | null

First name of the person.

lastName

string | null

Last name of the person.

initials

string | null

Initials of the person.

middleName

string | null

Middle name of the person.

prefixLastName

string | null

Prefix last name of the person.

birthName

string | null

Birth name of the person.

genderShortCode

string | null

Gender shortcode of the person. In the reference data endpoint 'genders' a user can get the full list of available values.

maritalStatusShortCode

string | null

Marital status shortcode of the person. In the reference endpoint API 'marital-statuses' a user can get the full list of available values.

birthDate

date | null

Birth date of the person.

nationalityShortCode

string | null

Nationality shortcode of the person. In the reference data endpoint 'nationalities' a user can get the full list of available values.

socialSecurityNumber

string | null

Social security number of the person. When the country of the social security number is NL (Netherlands) system checks if the syntax is according the set standards for Dutch social security syntax.

socialSecurityNumberCountryShortCode

string | null

Country shortcode of the social security number. In the reference data endpoint 'countries' a user can get the full list of available values.

placeOfBirth

string | null

Place of birth of the person.

countryOfBirthShortCode

string | null

Birth country shortcode of the person. In the reference data endpoint 'countries' a user can get the full list of available values.

preferredLanguageShortCode

string | null

Preferred language shortcode of the person. In the reference data endpoint 'languages' a user can get the full list of available values.

salutation

string | null

Salutation for the person.

notes

string | null

email1

string | null

E-mail address of the person.

email2

string | null

E-mail address of the person.

mobilePhone

string | null

Mobile phone of the person.

homePhone

string | null

Home phone of the person.

workPhone

string | null

Work phone of the person.

riskRatingShortCode

string | null

Risk rating shortcode of the company. In the reference data endpoint 'risk-ratings' a user can get the full list of available values.

reviewFrequency

string | null

Review frequency of the risk rating in months, so 12 means that every 12 months the risk rating needs to be checked.

lastCheckDate

date | null

Date the last risk rating was performed.

usPerson

boolean | null

Indicator whether the person is a US person.

reference

string | null

An external and/or user friendly reference of the person.

occupation

string | null

Occupation of the person.

prefixBirthName

string | null

Prefix of the birth name.

income

double | null

Income of the person.

numberOfDependents

int64 | null

Number of people who depend upon you for their support and welfare.

titleShortCode

array of strings | null

Title(s) of the person.

titleShortCode

addresses

array of objects | null

addresses

customFields

array of objects | null

customFields

identityDocuments

array of objects | null

identityDocuments

Headers

x-request-id

uuid

required

Format - uuid. Correlates HTTP requests between a client and server

Responses

202

Accepted

500

Server Error

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

401Unauthorized

403Forbidden

422Client Error