API Reference
Log In

Submit Information about Company Officers


This endpoint allows you to submit information for Company Officers. Prior to submitting those details you will have to upload their IDs. It is required when Company Officer owns 20 or percentage of the company. Please refer to Upload Compnay Offcer ID endpoint.

Data Requirements

Provide the following data when sending a POST request to the Company Officers endpoint.

Additional Header parameter:

Parameter Required? Description Type
Client-Id No Unique identifier of Child Account (required only for Partner). See Authentication Page to learn more. String

The body of the request should contain a key of “officers” with the requested officers contained in an array. Each officer must contain the following information::

Parameter Required? Description Type
name Yes Name of the company officer. This field includes their first name, middle name (if applicable) and last name. String
percentOfOwnership Yes Positive number of the Officer's ownership of the company. Make sure that all submitted company officers sum of ownership is not more that 100%. Number
dateOfBirth Yes Date of birth of Company Officer. The format of this field should be YYYY-MM-DD. String
countryOfResidence Yes The two letter ISO code for the Company Officer's country of residence. You can retrieve borderless™ supported countries via Reference Section of the Payouts API. String
zoneCode Yes Zone codes for Company's Officer country of residence. You can retrieve zone codes via Reference Section of the Payout API. String
uploadedIdReference Yes/No The referenece of the uploaded Compnay Officer's ID. This reference number is returned in the response as documentReferenceId when successfully Uploading Company Officers ID. This field is required when officer owns 20 or more percent of the company. String
jobTitle No A formal name for a specific position within an organization. To retrieve all possible job titles for this field please visit Reference Section. String
Click Try It! to start a request and see the response here!