Create An Address For A Profile

Request

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

Security

bearerToken

Path

profileIdstring, (uuid)required

id of the profile

Bodyapplication/json

typestring or nullrequired

The type of the address.

Enum:"registered""trading""other"

buildingDetailsstring or null

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

streetstring or null

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

citystring or null

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

regionstring or null

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

postalCodestring or null

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

countryCodestring or null

Two-letter ISO-3166-2 country code

descriptionstring or nullrequired

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

curl -i -X POST \
  'https://connect.sandbox.creditsafe.com/v1/compliance/kyc-protect/profiles/{profileId}/details/addresses' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "type": "registered",
    "buildingDetails": "string",
    "street": "string",
    "city": "string",
    "region": "string",
    "postalCode": "string",
    "countryCode": "string",
    "description": "string"
  }'

Responses

Created

Bodyapplication/json

idstring, (uuid)

Id of the address

buildingDetailsstring or null

Building details of the address

streetstring or null

Street of the address

citystring or null

City of the address

regionstring or null

Region of the address

postalCodestring or null

Postalcode of the address

countryCodestring or null

Two-letter country code ISO-3166-2

typestring

Type of the address (registered, trading, other)

descriptionstring or null

Description of the address

createdAtstring, (date-time)

Address created date time

createdByIdinteger, (int32)

Id of the user who created the Address

createdBystring

Name of the user who created the Address

modifiedAtstring or null, (date-time)

Address last updated date time

modifiedByIdinteger or null, (int32)

Id of the user who last modified the Address

modifiedBystring or null

Name of the user who last modified the Address

Response

{
  "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"
}