List Identity Documents

This endpoint enables you to get a list of all documents associated with an identity.

GET /identity/identities/{identity_id}/documents

Try it

List Identity Documents

cURL

curl --request GET \
  --url https://api.paxos.com/v2/identity/identities/{identity_id}/documents \
  --header 'Authorization: Bearer <token>'

200

{
  "documents": [
    {
      "file_id": "e1959b03-8c3d-4bdd-9437-403ccf8772f5",
      "name": "test_file.png",
      "document_types": [
        "OTHER_DOCUMENTS",
        "APPLICATION"
      ],
      "created_at": "2023-07-07T23:03:19.170481Z"
    }
  ]
}

OAuth Scope

identity:read_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

id associated with the identity

Query Parameters

include_pending_docs · boolean

Add a list of pending document types for the identity

Response

200

application/json

A successful response.

documents · A list of documents · object[]

Show child attributes

documents. file_id · string

documents. name · string

documents. document_types · enum<string>[]

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

documents. created_at · string<date-time>

documents. archived_at · string<date-time>

pending_documents · enum<string>[]

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