POST/api/v2/business/onboarding/associated-people/{associatedPersonId}/documents

Upload an EqualsMoney associated person onboarding document

Uploads one identity, address, or supporting document for an EqualsMoney associated person.

Authentication

Send your API key in the x-api-key header on every request.

Parameters

Request parameters
FieldTypeRequiredDescription
associatedPersonId (path)stringYesID of the associated person
userId (query)unknownNoRequired for API key authentication; optional for JWT self-service and must match the token user when supplied.

Request body

multipart/form-data

Request body fields
FieldTypeRequiredDescription
FileIFormFileNoDocument file to upload for the EqualsMoney associated person.
PurposePROOF_OF_IDENTITY | PROOF_OF_ADDRESS | OTHERNoUse PROOF_OF_IDENTITY for identity documents, PROOF_OF_ADDRESS for address documents, or OTHER for requested supporting documents. Possible values: PROOF_OF_IDENTITY, PROOF_OF_ADDRESS, OTHER.

Responses

200 — OK

Response 200 fields
FieldTypeRequiredDescription
idstringNo
applicationIdstringNo
associatedPersonIdstringNo
purposestringNo
createdAtstring (date-time)No
updatedAtstring (date-time)No

400 — Bad Request

Response 400 fields
FieldTypeRequiredDescription
MessagestringNo
CodestringNo
StatusunknownNo
ValidationErrorsobjectNo
DetailsstringNo

401 — Unauthorized

Response 401 fields
FieldTypeRequiredDescription
MessagestringNo
CodestringNo
StatusunknownNo
ValidationErrorsobjectNo
DetailsstringNo

404 — Not Found

Response 404 fields
FieldTypeRequiredDescription
MessagestringNo
CodestringNo
StatusunknownNo
ValidationErrorsobjectNo
DetailsstringNo

500 — Internal Server Error

Response 500 fields
FieldTypeRequiredDescription
MessagestringNo
CodestringNo
StatusunknownNo
ValidationErrorsobjectNo
DetailsstringNo

Example request

curl -X POST "https://{base_url}/api/v2/business/onboarding/associated-people/{associatedPersonId}/documents" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: multipart/form-data" \
  -d '{}'

This page is generated from the live OpenAPI specification and always matches the current API.