GET
/
api
/
v2.1
/
organization
/
documents
/
getByPurpose
/
{purpose}
/
{organizationId}
curl --request GET \
  --url https://sandbox.finhub.cloud/api/v2.1/organization/documents/getByPurpose/{purpose}/{organizationId} \
  --header 'X-Forwarded-For: <x-forwarded-for>'
{
  "success": true,
  "message": "<string>",
  "data": [
    {
      "id": "<string>",
      "documentType": "<string>",
      "documentNumber": "<string>",
      "issuingCountry": "<string>",
      "issueDate": "2022-03-10T00:00:00.000Z",
      "expiryDate": "2022-03-10T00:00:00.000Z",
      "purpose": "<string>",
      "status": "<string>",
      "fileUrl": "<string>",
      "fileName": "<string>",
      "fileType": "<string>",
      "fileSize": "<string>",
      "uploadedAt": "2022-03-10T00:00:00.000Z"
    }
  ]
}

Headers

X-Forwarded-For
string
required

Forwarded client IP address

User-Agent
string

Client user agent information

X-Tenant-ID
string

Tenant identifier for multi-tenant operations

Path Parameters

organizationId
string
required
purpose
string
required

Response

200 - application/json

OK

The response is of type object.