Upload Document

curl --request POST \
  --url https://api.rolla.xyz/api/v1/external/accounts/{accountId}/documents \
  --header 'Content-Type: multipart/form-data' \
  --header 'X-API-Key: <api-key>' \
  --form file='@example-file' \
  --form relatedPersonId=3c90c3cc-0d44-4b50-8888-8dd25736052a

import requests

url = "https://api.rolla.xyz/api/v1/external/accounts/{accountId}/documents"

files = { "file": ("example-file", open("example-file", "rb")) }
payload = { "relatedPersonId": "3c90c3cc-0d44-4b50-8888-8dd25736052a" }
headers = {"X-API-Key": "<api-key>"}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('file', '<string>');
form.append('relatedPersonId', '3c90c3cc-0d44-4b50-8888-8dd25736052a');

const options = {method: 'POST', headers: {'X-API-Key': '<api-key>'}};

options.body = form;

fetch('https://api.rolla.xyz/api/v1/external/accounts/{accountId}/documents', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.rolla.xyz/api/v1/external/accounts/{accountId}/documents",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"relatedPersonId\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Content-Type: multipart/form-data",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.rolla.xyz/api/v1/external/accounts/{accountId}/documents"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"relatedPersonId\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.rolla.xyz/api/v1/external/accounts/{accountId}/documents")
  .header("X-API-Key", "<api-key>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"relatedPersonId\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.rolla.xyz/api/v1/external/accounts/{accountId}/documents")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"relatedPersonId\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "message": "Document uploaded successfully",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "applicationId": "<string>",
    "documentType": "certificate_of_incorporation",
    "fileName": "<string>",
    "fileUrl": "<string>",
    "relatedPersonKey": "<string>",
    "created_at": "2023-11-07T05:31:56Z"
  }
}

{
  "success": false,
  "message": "<string>"
}

{
  "success": false,
  "message": "<string>"
}

{
  "success": false,
  "message": "<string>"
}

POST

accounts

{accountId}

documents

Upload Document

curl --request POST \
  --url https://api.rolla.xyz/api/v1/external/accounts/{accountId}/documents \
  --header 'Content-Type: multipart/form-data' \
  --header 'X-API-Key: <api-key>' \
  --form file='@example-file' \
  --form relatedPersonId=3c90c3cc-0d44-4b50-8888-8dd25736052a

import requests

url = "https://api.rolla.xyz/api/v1/external/accounts/{accountId}/documents"

files = { "file": ("example-file", open("example-file", "rb")) }
payload = { "relatedPersonId": "3c90c3cc-0d44-4b50-8888-8dd25736052a" }
headers = {"X-API-Key": "<api-key>"}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('file', '<string>');
form.append('relatedPersonId', '3c90c3cc-0d44-4b50-8888-8dd25736052a');

const options = {method: 'POST', headers: {'X-API-Key': '<api-key>'}};

options.body = form;

fetch('https://api.rolla.xyz/api/v1/external/accounts/{accountId}/documents', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.rolla.xyz/api/v1/external/accounts/{accountId}/documents",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"relatedPersonId\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Content-Type: multipart/form-data",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.rolla.xyz/api/v1/external/accounts/{accountId}/documents"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"relatedPersonId\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.rolla.xyz/api/v1/external/accounts/{accountId}/documents")
  .header("X-API-Key", "<api-key>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"relatedPersonId\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.rolla.xyz/api/v1/external/accounts/{accountId}/documents")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"relatedPersonId\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "message": "Document uploaded successfully",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "applicationId": "<string>",
    "documentType": "certificate_of_incorporation",
    "fileName": "<string>",
    "fileUrl": "<string>",
    "relatedPersonKey": "<string>",
    "created_at": "2023-11-07T05:31:56Z"
  }
}

{
  "success": false,
  "message": "<string>"
}

{
  "success": false,
  "message": "<string>"
}

{
  "success": false,
  "message": "<string>"
}

Uploads a document to an account’s application as multipart/form-data. Re-uploading the same documentType replaces the previous file. To attach a document to a specific beneficial owner or director, include their relatedPersonId.

Example Request

curl -X POST "https://api.rolla.xyz/api/v1/external/accounts/eec3cbed-79d8-4370-87a0-b6be9e287337/documents" \
  -H "X-API-Key: your_api_key_here" \
  -F "file=@/path/to/certificate.pdf" \
  -F "documentType=certificate_of_incorporation"

Form Fields

Field	Type	Required	Description
`file`	file	Yes	The document file (max 50MB)
`documentType`	string	Yes	One of the document types below
`relatedPersonId`	string	No	Attach the document to a specific related person

Document Types

Required for business accounts: certificate_of_incorporation, articles_of_association, proof_of_address, director_register, shareholder_register, bank_statement Required for each beneficial owner and director: proof_of_address, source_of_wealth_doc — upload with that person’s relatedPersonId Required for individual accounts: proof_of_address Optional / compliance: proof_of_tax_id, wolfsberg_questionnaire, msb_flow_form, flow_of_funds_diagram, aml_policy_procedures, ach_procedures, wire_procedures, customer_complaint_procedures, prohibited_jurisdictions_industries

Example Response

{
  "success": true,
  "message": "Document uploaded successfully",
  "data": {
    "id": "0c95b2a1-7a93-4a3a-9a52-2a1f0b9b3c11",
    "kyb_application_id": "fbb45236-881a-4c58-8954-22759499eab4",
    "document_type": "certificate_of_incorporation",
    "file_name": "certificate.pdf",
    "file_size": 248301,
    "mime_type": "application/pdf"
  }
}

Proof of address documents must have been issued within the last 3 months (bank statement, utility bill or lease agreement).

Authorizations

X-API-Key

string

header

required

Your Rolla API key

Path Parameters

accountId

string<uuid>

required

Identifier of an account owned by the same user as your API key's business

Body

multipart/form-data

file

required

documentType

enum<string>

required

Available options:

certificate_of_incorporation,

articles_of_association,

proof_of_address,

director_register,

shareholder_register,

proof_of_tax_id,

bank_statement,

wolfsberg_questionnaire,

msb_flow_form,

flow_of_funds_diagram,

aml_policy_procedures,

ach_procedures,

wire_procedures,

customer_complaint_procedures,

prohibited_jurisdictions_industries

Response

Document uploaded successfully

success

boolean

Example:

true

message

string

Example:

"Document uploaded successfully"

data

object

Show child attributes

Overview

Banks

Account Lookup

Transactions

Wallet

Beneficiaries

Teams

Account Onboarding

Webhooks

Upload Document

Example Request

Form Fields

Document Types

Example Response

Authorizations

Path Parameters

Body

Response

​Example Request

​Form Fields

​Document Types

​Example Response

Authorizations

Path Parameters

Body

Response

Example Request

Form Fields

Document Types

Example Response