Upload a document for an application

curl --request POST \ --url https://api.circle.com/v1/onboarding/partner/applications/{applicationId}/documents \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: multipart/form-data' \ --header 'X-Idempotency-Key: <x-idempotency-key>' \ --form 'datumName=<string>' \ --form fileContent='@example-file' \ --form 'fileName=<string>' \ --form 'issuedCountry=<string>' \ --form refId=3c90c3cc-0d44-4b50-8888-8dd25736052a

Authorizations

Authorization

string

header

required

Bearer token obtained via Circle key exchange

Headers

X-Idempotency-Key

string<uuid>

required

Client-generated UUID used to safely retry POST requests. If the same key is submitted twice, the original response is returned without re-executing the operation. Must be a valid UUID v4 (e.g. 550e8400-e29b-41d4-a716-446655440099).

Path Parameters

applicationId

string<uuid>

required

Application UUID

Body

multipart/form-data

Multipart form data for document upload

datumName

string

required

Datum (field) name this document satisfies (e.g. passport_document)

fileContent

file

required

Binary file content

fileName

string

required

Original file name including extension (e.g. passport.pdf)

documentType

enum<string>

Type of identity document being uploaded. Required when the schema field carries an x-documentTypes extension — check the field definition in GET /{applicationId}/schema to see which values are accepted for a given datum. Standard government ID datums accept passport, usdl, or usid; notarized government ID datums accept idNotarization. Ignored for all other datums — the service derives the type automatically from the datum name.

Available options:

addressDoc,

amlPolicyDoc,

bankStatement,

businessLicense,

fincenDoc,

fundDoc,

fundFormDExemDoc,

genericDoc,

idNotarization,

orgDoc,

orgLicense,

passport,

securityControlsCertification,

usdl,

usid

issuedCountry

string

ISO 3166-1 alpha-2 country code where the document was issued (required for identity documents)

refId

string<uuid>

Reference ID of the array entity this document belongs to (required for array sections)

Response

Uploaded document reference

documentId

string<uuid>