Creates An Address For Profile

Creates an address for the given profileId. Returns the created address information.

SecuritybearerToken
Request
path Parameters
profileId
required
string <uuid>

id of the profile

Request Body schema: application/json
type
required
string or null

The type of the address.

Enum: "registered" "trading" "other"
buildingDetails
string or null

The building details of the address being created. Must have a maximum length of 250 characters.

street
string or null

The street of the address being created. Must have a maximum length of 250 characters.

city
string or null

The city of the address being created. Must have a maximum length of 250 characters.

region
string or null

The region of the address being created. Must have a maximum length of 250 characters.

postalCode
string or null

The postal code of the address being created. Must have a maximum length of 50 characters.

countryCode
string or null

Two-letter ISO-3166-2 country code

description
required
string or null

The description of the address being created. Must have a maximum length of 250 characters

Responses
201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

409

Conflict

post/compliance/kyc-protect/profiles/{profileId}/details/addresses
Request samples
application/json
{
  • "type": "registered",
  • "buildingDetails": "string",
  • "street": "string",
  • "city": "string",
  • "region": "string",
  • "postalCode": "string",
  • "countryCode": "string",
  • "description": "string"
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "buildingDetails": "string",
  • "street": "string",
  • "city": "string",
  • "region": "string",
  • "postalCode": "string",
  • "countryCode": "string",
  • "type": "string",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdById": 0,
  • "createdBy": "string",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedById": 0,
  • "modifiedBy": "string"
}
➔ Next to Return Lists Of Addresses