Onboarding
Upload associate identity documents
Changed onUploads identity and address verification documents for a specific associate as multipart/form-data.
Use associateId from the onboarding status response (GET /onboarding/v1/applications/{onboardingId}/status).
Jurisdiction guidance:
- EU: selfie/liveness and proof of address are generally mandatory.
- US: selfie may be optional while tax and control-person requirements can apply.
If a submitted document is rejected, resubmit a corrected file through the same endpoint; the previous rejected document is replaced.
post/onboarding/v1/associates/{associateId}/identification-documents
Request
- Base URLhttps://api.sandbox.bvnk.com
- AuthAPI key in header Authorization
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
associateIdstring uuid required
Example:07b099fa-e1ee-4ad4-9cc4-6f2513a5a240
Associate ID returned by onboarding status response.
Request body multipart/form-data
Example request
{
"metadata": "[{\"type\":\"PASSPORT\",\"name\":\"passport.png\",\"countryCode\":\"DE\"},{\"type\":\"UTILITY_BILL\",\"name\":\"poa.png\",\"countryCode\":\"DE\"},{\"type\":\"SELFIE\",\"name\":\"selfie.jpeg\",\"countryCode\":\"DE\"}]"
}Response
Associate documents accepted for processing
Changes
- info
endpoint added
- info