Organization
Get organization documents by purpose
Home
Token
Merchant API
Customer
- 2FA
- AccessControl
- Active Session
- Credentials
- Customer
- Organization
- PATCHCreate business address
- POSTCreate business customer documents
- POSTCreate Organization Bulk
- POSTCreate Organization by Customer Type
- POSTCreate Organization
- POSTCreate Organization Additional Data
- DELDelete organization entity
- DELDelete organization shareholder delete
- POSTGet Organization By Business Type
- POSTGet Organization By Customer Type
- GETGet Organization Details
- GETGet organization documents by purpose
- GETGet organization documents
- GETGet organization entity
- GETGet organization get address
- GETGet organization get by id
- GETGet organization
- GETGet organization shareholder get
- PATCHPatch organization entity create
- PATCHPatch organization entity update
- PATCHPatch organization shareholder create
- PATCHPatch organization shareholder update
- POSTPost organization get all
- PUTPut organization update kyb status
- PUTPut organization update status
- PUTUpdate Organization
- PATCH
- Profile Picture
Open Banking API
- Introduction
- POSTToken
- Account
- TPP
Organization
Get organization documents by purpose
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
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
Document Purpose
Available options:
KYB
, KYC
, PEP&SANCTION
Organization id
Response
200
application/json
Get organization document response
Available options:
KYB
, KYC
, PEP&SANCTION
Available options:
ID front side
, ID back side
, Passport
, accountAuthority
, shareholderStructure
, operationAddress
, registeredAddress
, selfie
, livelinessDetection
Available options:
underverification
, verified
, declined
, incomplete
, expired
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>"
}
]
}
]
}
]