Skip to main content
POST
/
kyb
/
documents
Upload KYB Document
curl --request POST \
  --url https://api.rolla.xyz/api/v1/external/kyb/documents \
  --header 'Content-Type: multipart/form-data' \
  --header 'X-API-Key: <api-key>' \
  --form file='@example-file' \
  --form 'applicationId=<string>' \
  --form 'documentType=<string>' \
  --form 'relatedPersonKey=<string>'
{
  "success": true,
  "message": "Document uploaded successfully",
  "data": {
    "document": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "applicationId": "<string>",
      "documentType": "<string>",
      "fileName": "<string>",
      "fileUrl": "<string>",
      "relatedPersonKey": "<string>",
      "created_at": "2023-11-07T05:31:56Z"
    }
  }
}
Upload a document for a KYB application. This endpoint accepts multipart/form-data with the document file and metadata.

​
Example Request

curl -X POST "https://api.rolla.xyz/api/v1/external/kyb/documents" \
  -H "X-API-Key: your_api_key_here" \
  -F "file=@/path/to/certificate.pdf" \
  -F "applicationId=f6a7b8c9-d0e1-2345-fghi-678901234567" \
  -F "documentType=certificate_of_incorporation"

​
Form Fields

FieldTypeRequiredDescription
filefileYesThe document file to upload
applicationIdstringYesKYB application ID
documentTypestringYesType of document being uploaded
relatedPersonKeystringNoRelated person identifier (for person-specific documents)

​
Example Response

{
  "success": true,
  "message": "Document uploaded successfully",
  "data": {
    "document": {
      "id": "a7b8c9d0-e1f2-3456-ghij-789012345678",
      "applicationId": "f6a7b8c9-d0e1-2345-fghi-678901234567",
      "documentType": "certificate_of_incorporation",
      "fileName": "certificate.pdf",
      "fileUrl": "https://storage.rolla.xyz/documents/certificate.pdf",
      "created_at": "2024-01-15T10:30:00.000Z"
    }
  }
}
Use the relatedPersonKey field when uploading documents for specific directors or beneficial owners (e.g., ID documents, proof of address).

Authorizations

​
X-API-Key
string
header
required

Your Rolla API key

Body

multipart/form-data
​
file
file
required

The document file to upload

​
applicationId
string
required

KYB application ID

​
documentType
string
required

Type of document being uploaded

​
relatedPersonKey
string

Related person identifier (if applicable)

Response

Document uploaded successfully

​
success
boolean
Example:

true

​
message
string
Example:

"Document uploaded successfully"

​
data
object