Add a Business Owner Identity Document

POST /accountmanagement/v1/businessowners/business_owner_id/canadiandrivinglicenses

In order to complete the creation of the business owner, you may also have to add an identity document, depending on the jurisdiction. The ID required varies by the region of the business owner, so the endpoints vary accordingly.

  • For a Canadian business owner, adding a Canadian Driving License as an ID is optional.
  • For a European business owner, you must add one of the three eligible ID documents: European identity card, UK driving license, or international passport.
Region Identity Document Endpoint
Canada Driving License (Optional) /canadiandrivinglicenses
Europe Identity Card /europeanidentitycards
UK Driving License /ukdrivinglicenses
International Passport /internationalpassports

You must initiate a POST request to the canadiandrivinglicences endpoint to create a driving license as an ID that will be associated with the business owner.

This example is for a driving license for a Canadian business owner. Please consult the table above for requirements for business owners from other regions.

Request Example
curl -X POST https://api.test.paysafe.com/accountmanagement/v1/businessowners/5e3680da-cfac-4917-855a-181c8fe27751/canadiandrivinglicenses \
-u devcentre322:B-qa2-0-53625f86-302c021476f52bdc9deab7aea876bb28762e62f92fc6712d0214736abf501e9675e55940e83ef77f5c304edc7968 \
-H 'Content-Type: application/json' \
  -d ' {
    "number": "DL987654321",
    "province": "ON",
    "issueDate": {
        "day": "15",
        "month": "9",
        "year": "2016"
    },
    "expiryDate": {
        "day": "15",
        "month": "9",
        "year": "2021"
    }
}'

Prior to trying the example above, you should:

  • Replace the business owner ID (5e3680da-cfac-4917-855a-181c8fe27751) with the id you received in response to the business owner creation request.
  • Replace the API key (after the -u) with the API key you have received
Response Example
{
	"links": [{
		"rel": "self",
		"href": "https://api.test.paysafe.com/accountmanagement/v1/canadiandrivinglicenses/8b670bf0-f218-4710-86a9-1b100206e1c1"
	}],
	"id": "8b670bf0-f218-4710-86a9-1b100206e1c1",
	"number": "*********21",
	"province": "ON",
	"issueDate": {
		"day": "15",
		"month": "9",
		"year": "2016"
	},
	"expiryDate": {
		"day": "15",
		"month": "9",
		"year": "2021"
	}
}

See the Endpoint sections in the table above for a list of all the JSON attributes and types available for each of the endpoints.

Did you find this page useful?