Business profiles
A business profile is a business (KYB) customer you onboard under your partner account, together with its beneficial owners, directors and shareholders.
The flow
Create the profile
Create business profile with the business people in businessPersonList. The customer is queued for compliance review straight away.
Upload documents
Request an upload link, then PUT the file to the returned URL.
Confirm the documents
Send the document ids in businessDocumentIdList on Update business profile.
Get the decision
Listen for the customer.onboarding.* webhooks, or poll Get verification status.
Endpoints
| Endpoint | Scope | |
|---|---|---|
| POST | /partner/v1/business-profiles | partner.write |
| PATCH | /partner/v1/business-profiles/{customerId} | partner.write |
| GET | /partner/v1/business-profiles | partner.read |
| GET | /partner/v1/business-profiles/{customerId} | partner.read |
| GET | /partner/v1/business-profiles/by-reference/{partnerCustomerId} | partner.read |
| POST | /partner/v1/business-profiles/{customerId}/documents/upload-link | partner.write |
| GET | /partner/v1/business-profiles/{customerId}/verification-status | partner.read |
Key ideas
- Your id and ours. You send
partnerCustomerId, your own reference. Ryno returnscustomerId. Every other route takescustomerId, except lookup by reference. - Safe retries. Create is idempotent on
partnerCustomerId, and every write is all-or-nothing. - Editable until review. You can update a profile until an analyst starts reviewing it, and again when changes are requested. See Statuses.
Shared response and error formats are on the API introduction.