Upload a person's identity document

post

https://api.sandbox.alfredpay.io/v1/persons/{relatedPersonId}/documents

Same limits and shape as the business upload. Needs the relatedPersonId returned by the KYB or KYC submission, so run that first.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

relatedPersonId

string

required

Returned per related person by POST …/kyb.

Body Params

file

required

PDF, JPEG or PNG. 10 MB maximum.

purposes

array of strings

required

What this file evidences, for example INCORPORATION, PROOF_OF_ADDRESS, SHAREHOLDER_REGISTRY, ID_FRONT, ID_BACK, SELFIE.

purposes*

documentType

string

issuingCountry

string

enum

ISO 3166-1 alpha-3, the only form Alfred stores, filters on, reports or emits. Compatibility rule for
integrations that can only send alpha-2: any inbound country value in alpha-2 (path, query or body) is
normalized to alpha-3 at the boundary before validation, storage or routing. Unrecognized in either form
→ 422 validation_error.

fileName

string

description

string

Headers

Idempotency-Key

uuid

required

Required on every state-changing POST, simulators included; the only exempt POST is …/verifications/preflight.
Replay (same key, same body) returns the original response with Idempotent-Replayed: true; same key with a
different body → 409 idempotency_conflict. Keys are UUIDs, scoped to the API key, retained for 24 hours.

Responses

201Uploaded

404The resource does not exist, or belongs to another partner.

413file_too_large: the 10 MB per-file limit was exceeded.

415unsupported_file_type: only PDF, JPEG and PNG are accepted.