GET
/
documents
/
getByPurpose
/
{purpose}
/
{customerId}
curl --request GET \
  --url https://gateway.finhub.cloud/customer/documents/getByPurpose/{purpose}/{customerId} \
  --header 'Authorization: Bearer <token>' \
  --header 'tenantId: <tenantid>'
{
  "tenantId": "<string>",
  "documents": [
    {
      "purpose": "KYB",
      "name": "<string>",
      "documentType": "ID front side",
      "location": "<string>",
      "verificationResponse": "<string>",
      "status": "underverification",
      "metadata": [
        {
          "name": "<string>",
          "type": "Number",
          "value": "<string>"
        }
      ]
    }
  ]
}

Authorizations

Authorization
string
headerrequired

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

tenantId
string
required

Tenant/Owner id

Path Parameters

purpose
enum<string>[]
required

Document Purpose

Available options:
KYB,
KYC,
PEP&SANCTION
customerId
string
required

Customer Id

Response

200 - application/json
tenantId
string
documents
object[]