Skip to main content

Put Customer

PUT 

/customers/:CustomerID

Creates or updates a customer record. A unique CustomerID must be provided, as the API does not generate this identifier. For consistency, it is recommended to use the customer ID from your internal system as the CustomerID. This customer record must exist before executing any operations that depend on the CustomerID.

Request

Path Parameters

    CustomerID CustomerIDrequired

    Possible values: non-empty and <= 36 characters

Header Parameters

    Api-Signature string

    Digitally signed JWT.

Body

required
    FullNameobjectrequired
    FirstName stringrequired

    user's first name

    Possible values: non-empty and <= 50 characters

    LastName stringrequired

    user's last name (family name)

    Possible values: non-empty and <= 50 characters

    MiddleName string

    user's middle name

    Possible values: non-empty and <= 50 characters

    DateOfBirth daterequired

    Possible values: >= 10 characters and <= 10 characters

    Example: 2024-04-16
    Identitiesobject[]required
  • Array [

  • IssuingCountry CountryCode (string)required

    ISO 3166-1 alpha-2 country code.

    Example: US
    IDNumber stringrequired

    Possible values: non-empty and <= 36 characters

    IssuedDate date

    Possible values: >= 10 characters and <= 10 characters

    Example: 2024-04-16
    ExpiryDate date

    Possible values: >= 10 characters and <= 10 characters

    Example: 2024-04-16
    IDType IDType (string)required

    Type of identification document:

    • DrivingLicense
    • NationalIDCard
    • Passport
    • AddressProof
    • ResidencePermit
    • TaxID
    Example: Passport
  • ]

  • PrimaryResidenceobjectrequired
    Street stringrequired

    Street: the primary name of an address's street.

    Possible values: >= 2 characters and <= 200 characters

    Street2 string

    Street2: the secondary name of an address's street.

    City stringrequired

    City: name of an address's city or town.

    Possible values: non-empty and <= 100 characters

    PostCode stringrequired

    PostCode: the address's postcode

    Possible values: non-empty and <= 20 characters

    State stringrequired

    State: the address's state / province / county. For USA and Canada, state code in ISO 3166-2 code (e.g. CA) is required.

    Possible values: non-empty and <= 100 characters

    Country CountryCode (string)required

    ISO 3166-1 alpha-2 country code.

    Example: US

Responses

Customer created
Loading...