v1

latestOpenAPI 3.0.02026-07-2436163302.7 KB

Get individual details

Used to retrieve details for a successfully onboarded individual.

get/onboarding/v2/individuals/{id}

Path parameters

idstring required

The identifier of the individual

Response

Ok - individual details retrieved successfully.

messagestring

statusstring

The status of the request.

Example response

{
  "data": {
    "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"
    }
  },
  "errors": [
    {
      "type": "validation"
    }
  ]
}