Sign in

v1

latestOpenAPI 3.0.02026-07-2436163302.7 KB

Onboard an individual

Similar to the Company onboarding, the Individual onboarding endpoint allows you to onboard any individual or physical person who is part of a transaction. In most cases (i.e. B2C transactions), the Customer will be a physical person and you should use this endpoint to onboard them.

post/onboarding/v2/individuals

Request body

full_namestring required

Full name of the individual

Validations:

  • Required property
  • Length between 1 and 450
operatorboolean
personal_numberstring required

Specifies a unique personal identifier for a b2c customer. This can be customers’ email address, account number, etc. Used for deduplication purposes.

Validations:

  • Required property
  • Length between 1 and 50
personal_number_typestring

Validations:

  • Length between 0 and 20

Example request

{
  "address": {
    "address_line_1": "123 Main Street",
    "address_line_2": "Suite 400",
    "canton": "Zürich",
    "city": "San Francisco",
    "city_code": "SF123",
    "country_code": "US",
    "district": "Financial District",
    "neighbourhood": "Downtown",
    "number": "123",
    "postal_code": "94105",
    "prefix": "North",
    "province": "Ontario",
    "region": "Midwest",
    "state": "California",
    "suffix": "Avenue"
  },
  "contact_details": {
    "certified_email": "certified@company.com",
    "email": "contact@company.com",
    "phone_number": "+1-800-123-4567",
    "website": "https://www.company.com"
  },
  "tax_information": {
    "activity_code": "ACT-200",
    "additional_tax_numbers": [
      {
        "country_code": "US",
        "country_subdivision_code": "CA",
        "tax_number": "123456789"
      }
    ],
    "authorization_code": "AUTH-987654",
    "billing_file_number": "BFN-00123",
    "device_id": "DEVICE-456789",
    "document_type": "INVOICE",
    "eac_code": "6201",
    "point_of_sale": "POS-1001",
    "regime": "VAT",
    "tax_code": "TX-001",
    "tax_number": "123456789"
  }
}

Response

Accepted - individual was successfully onboarded.

messagestring
statusstring

Example response

{
  "data": {
    "job_id": "fad3e91a0a46489cbcb82db1693df05b"
  },
  "errors": [
    {
      "type": "validation"
    }
  ],
  "status": "success"
}