Document Upload

This endpoint enables you to receive a URL to upload a document to Paxos for identity verification or enhanced due diligence purposes. When uploading a document you must specify the document type. You will receive a URL where you can upload the document using a POST request.

Requirements:

• Uploaded documents must be less than 100 MB in size
• Supported formats include PDF, JPG, and PNG

For more information on document requirements for enhanced due diligence, see here.

PUT /identity/identities/{identity_id}/documents

Try it

Document Upload

cURL

curl --request PUT \
  --url https://api.paxos.com/v2/identity/identities/{identity_id}/documents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Proof_of_residence.jpg",
  "document_types": [
    "PROOF_OF_RESIDENCY"
  ]
}
'

200

{
  "file_id": "f190b163-208f-4d73-8deb-4fb8b24add00",
  "name": "Proof_of_residence.jpg",
  "upload_url": "https://s3.amasonaws.com/pax...cec3f64fe20348685a"
}

OAuth Scope

identity:write_identity

Authorizations

Authorization · string · header · required

Paxos APIs use OAuth 2 with the client credentials grant flow.

Token URLs:

• Production: https://oauth.paxos.com/oauth2/token
• Sandbox: https://oauth.sandbox.paxos.com/oauth2/token

Learn more in the API credentials guide →

Path Parameters

identity_id · string · required

The id of the identity the document is associated with.

Body

application/json

name · string · required

The file name.

document_types · enum<string>[]

A list of document types contained within the uploaded file.

Available options: OTHER_DOCUMENTS, APPLICATION, ORGANIZATIONAL_DOCUMENTS, CERTIFICATE_OF_GOOD_STANDING, TAX_IDENTIFICATION, IDENTITY_VERIFICATION, PROOF_OF_RESIDENCY, PROOF_OF_FUNDS, SAMPLE_INVOICE, OPERATING_AGREEMENT, TRUST_DOCUMENTS, MONEY_SERVICE_DOCUMENTS, INVESTMENT_DOCUMENTS, CURP, AML_DOCUMENTS, FUND_STRUCTURE_CHART, FUND_MANAGER_REGISTRATION, MEMORANDUM_OF_ASSOCIATION, ORGANIZATIONAL_CHART, FOUNDATION_BY_LAWS, APPOINTMENT_OF_GUARDIAN_EVIDENCE, LEGAL_DOMICILE_OF_BENEFICIAL_OWNERS, GOVERNING_BODY_MEMBER_NAMES

Response

200

application/json

A successful response.

file_id · string

The id assigned to the file.

name · string

The file name.

upload_url · string

The URI where we expect the file to be uploaded into.