Skip to main content
GET
/
kyb
/
documents
Get KYB Documents
curl --request GET \
  --url https://api.rolla.xyz/api/v1/external/kyb/documents \
  --header 'X-API-Key: <api-key>'
{
  "success": true,
  "message": "Documents retrieved successfully",
  "data": {
    "documents": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "applicationId": "<string>",
        "documentType": "<string>",
        "fileName": "<string>",
        "fileUrl": "<string>",
        "relatedPersonKey": "<string>",
        "created_at": "2023-11-07T05:31:56Z"
      }
    ]
  }
}
Retrieve documents associated with a KYB application. Filter by document type or related person.

Example Request

curl -X GET "https://api.rolla.xyz/api/v1/external/kyb/documents?applicationId=f6a7b8c9-d0e1-2345-fghi-678901234567" \
  -H "X-API-Key: your_api_key_here"

Query Parameters

ParameterTypeDescription
applicationIdstringRequired. KYB application ID
relatedPersonKeystringFilter by related person
documentTypestringFilter by document type

Example Response

{
  "success": true,
  "message": "Documents retrieved successfully",
  "data": {
    "documents": [
      {
        "id": "a7b8c9d0-e1f2-3456-ghij-789012345678",
        "applicationId": "f6a7b8c9-d0e1-2345-fghi-678901234567",
        "documentType": "certificate_of_incorporation",
        "fileName": "cert_of_inc.pdf",
        "fileUrl": "https://storage.rolla.xyz/documents/cert_of_inc.pdf",
        "created_at": "2024-01-12T09:00:00.000Z"
      }
    ]
  }
}

Authorizations

X-API-Key
string
header
required

Your Rolla API key

Query Parameters

applicationId
string
required

KYB application ID

Filter documents by related person

documentType
string

Filter by document type

Response

Documents retrieved successfully

success
boolean
Example:

true

message
string
Example:

"Documents retrieved successfully"

data
object