API ReferenceCorporate
Post Submit K Y B
Submit KYB
Authorization
ApiKeyAuth x-api-key<token>
API key
In: header
Header Parameters
x-api-key*string
API key for authentication
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/submitKYB" \ -H "x-api-key: string" \ -H "Content-Type: application/json" \ -d '{ "authorized_user_data": { "address1": "123 Business St", "city": "Toronto", "dob": "2021-01-01", "firstName": "John", "lastName": "Doe", "occupation": "Banker", "postal": "m1b5g5", "province": "on" }, "business_nature": "Corporation", "corporate_phone": "123-456-7890", "corporation_address": { "address1": "123 Business St", "city": "Toronto", "postal": "a1b2c3", "province": "on" }, "corporation_base64_url": [ { "name": "C:\\\\fakepath\\\\<img-name>.jpg", "type": "image/jpg", "url": "data:image/jpeg;base64,...data..." } ], "corporation_email": "corporation@email.com", "corporation_name": "Corporation", "corporation_number": "123456789", "date_of_incorp": "2021-01-01", "incorpCertData": "ontario", "is_pep": true, "is_quarter_owner": true, "list_of_directors": { "directorEmails": "john.doe@email.com", "directorNames": "John Doe", "directorOccupations": "Banker", "directorsDOB": "2021-01-01" }, "list_of_quarter_owners": { "quarterOwners": "John Doe", "quarterOwnersDOB": "2021-01-01", "quarterOwnersEmail": "john.doe@email.com", "quarterOwnersOccupation": "Banker" }, "msb_reg": true, "paytrie_email": "paytrie@email.com", "purpose": "payments", "source_of_funds": "business_revenue", "tpd": true }'{ "message": "Corporate documents uploaded successfully", "status": "success"}