GET
/
organization
/
documents
/
getByPurpose
/
{purpose}
/
{organizationId}
curl --request GET \
  --url https://gateway.cyrexa.com/customer/1.0.0/organization/documents/getByPurpose/{purpose}/{organizationId} \
  --header 'Authorization: Bearer <token>' \
  --header 'tenantId: <tenantid>' \
  --header 'token: <token>'
[
  {
    "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
header
required

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

Headers

​
token
string
required
​
tenantId
string
required

Tenant/Owner id

Path Parameters

​
purpose
enum<string>[]
required

Document Purpose

​
organizationId
string
required

Organization id

Response

200
application/json

Get organization document response

The response is of type object[].