Sandbox login
Guides
Start typing to search…

Account Regulatory Data

Create or update regulatory data for a Canadian account.

🚧

Availability Notice: This API will be available starting November 12, 2025. Requests before that date may be rejected.


Endpoint

POST /{accountId}/regulatoryData

  • Produces: application/json

Path Parameters

NameTypeRequiredDescription
accountIdLongYesTarget account ID whose regulatory data will be created/updated.

Request Headers

Headers

  • X-request-id: For example 48855846-628d-4177-b071-80332a116f0a
  • Authorization: Bearer bearerToken

bearerToken is the Authorization token that belongs to the partner

i.e. Bearer d49e7fd4-2600-4dd4-a572-118668febbe7

see this section to generate your bearerToken

Request Body

Example

{
  "firstName": "Jhon",
  "lastName": "Doe",
  "occupation": "Manager",
  "extraInfo": {
    "address": {
      "countryCode": "CA",
      "street": "123 Main St",
      "city": "123123",
      "stateProvince": "ON",
      "postalCode": "K2E2E2"
    }
  },
  "dob": "10/02/2007"
}

Field Reference

All fields below are validated. Unless stated otherwise, they are mandatory.

FieldTypeRequiredNotes / ConstraintsExample
firstNameStringYesNon-empty."Jhon"
lastNameStringYesNon-empty."Doe"
middleNameStringNoOptional field in current implementation."A"
occupationStringYesNon-empty."Manager"
dobLocalDate (MM/dd/yyyy)YesMust be a valid date formatted as MM/dd/yyyy. (If your business rule requires minimum age, enforce accordingly.)"10/02/2007"
extraInfoObjectYesContainer for address.{...}
extraInfo.addressObjectYesCanadian address only.{...}
extraInfo.address.countryCodeCountryCodeYesMust be CA."CA"
extraInfo.address.streetStringYesNon-empty."123 Main St"
extraInfo.address.cityStringYesNon-empty."123123"
extraInfo.address.stateProvinceStringYesMust match a valid Canadian region code ( ON, QC, NS, NB, MB, BC, PE, SK, AB, NL, NT, YT, NU). Case-insensitive."ON"
extraInfo.address.postalCodeStringYesNon-empty."K2E2E2"

Validation summary

  • The caller must belong to the correct partner for the accountId.
  • The target accountId must be Canadian (CA).
  • Every field marked Yes above is mandatory; middleName is optional.
  • stateProvince must be one of the supported region codes for Canada.

Responses

200 OK

Returns account regulatory data in JSON.

Error Conditions (examples)

HTTPCode/Exception (server-side)When
400This account 'A' cannot be set by caller 'B'Caller is not the configured partner for the accountId.
400The country US is invalid. Only Canada-CA is valid.Account is not CA or countryCode in the payload is not CA.
400The following parameter(s) is(are) missing: [...].One or more required fields are missing/blank (message lists fields).
400The state/provice CT is not valid.stateProvince not in supported Canadian region codes.

cURL Example

curl -X POST "https://<base-url>/{accountId}/regulatoryData" \
  -H "Authorization: Bearer <access_token>" \
  -H "Content-Type: application/json" \
  -d '{
    "firstName": "Jhon",
    "lastName": "Doe",
    "occupation": "Manager",
    "extraInfo": {
      "address": {
        "countryCode": "CA",
        "street": "123 Main St",
        "city": "123123",
        "stateProvince": "ON",
        "postalCode": "K2E2E2"
      }
    },
    "dob": "10/02/2007"
  }'

Notes for Maintainers

  • Keep the Availability Notice at the top until November 12, 2025. Remove it on/after release.
  • If middleName must become mandatory, add it to the required-fields check in validation and update the table accordingly.
  • If enforcing a minimum age, document the rule under dob and update validation.

Updated about 10 hours ago