Get document preview URLs

curl --request POST \
  --url https://api.blockradar.co/v1/customers/{customerId}/onboarding-requests/{caseId}/documents/view-url \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "documents": [
    {
      "storageKey": "<string>"
    }
  ]
}
'

import requests

url = "https://api.blockradar.co/v1/customers/{customerId}/onboarding-requests/{caseId}/documents/view-url"

payload = { "documents": [{ "storageKey": "<string>" }] }
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({documents: [{storageKey: '<string>'}]})
};

fetch('https://api.blockradar.co/v1/customers/{customerId}/onboarding-requests/{caseId}/documents/view-url', 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.blockradar.co/v1/customers/{customerId}/onboarding-requests/{caseId}/documents/view-url",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'documents' => [
        [
                'storageKey' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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.blockradar.co/v1/customers/{customerId}/onboarding-requests/{caseId}/documents/view-url"

	payload := strings.NewReader("{\n  \"documents\": [\n    {\n      \"storageKey\": \"<string>\"\n    }\n  ]\n}")

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

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	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.blockradar.co/v1/customers/{customerId}/onboarding-requests/{caseId}/documents/view-url")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"documents\": [\n    {\n      \"storageKey\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.blockradar.co/v1/customers/{customerId}/onboarding-requests/{caseId}/documents/view-url")

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["Content-Type"] = 'application/json'
request.body = "{\n  \"documents\": [\n    {\n      \"storageKey\": \"<string>\"\n    }\n  ]\n}"

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

{
  "status": true,
  "message": "<string>",
  "data": {
    "caseId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "documents": [
      {
        "storageKey": "<string>",
        "viewUrl": "<string>",
        "expiresAt": "2023-11-07T05:31:56Z"
      }
    ]
  }
}

{
  "statusCode": 123,
  "message": "<string>",
  "details": {
    "code": "CUSTOMER_ONBOARDING_REQUIRED",
    "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "provider": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "slug": "<string>",
      "name": "<string>"
    },
    "onboarding": {
      "caseId": "<string>",
      "status": "<string>",
      "providerStatus": "<string>",
      "action": {
        "type": "create_case",
        "method": "POST",
        "path": "/v1/customers/18d2f159-e0cd-4a45-b735-e9dfe0f7520a/onboarding-requests",
        "body": {
          "provider": "<string>",
          "type": "onramp"
        }
      }
    }
  },
  "requestId": "<string>"
}

{
  "statusCode": 123,
  "message": "<string>",
  "details": {
    "code": "CUSTOMER_ONBOARDING_REQUIRED",
    "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "provider": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "slug": "<string>",
      "name": "<string>"
    },
    "onboarding": {
      "caseId": "<string>",
      "status": "<string>",
      "providerStatus": "<string>",
      "action": {
        "type": "create_case",
        "method": "POST",
        "path": "/v1/customers/18d2f159-e0cd-4a45-b735-e9dfe0f7520a/onboarding-requests",
        "body": {
          "provider": "<string>",
          "type": "onramp"
        }
      }
    }
  },
  "requestId": "<string>"
}

POST

customers

{customerId}

onboarding-requests

{caseId}

documents

view-url

Get document preview URLs

curl --request POST \
  --url https://api.blockradar.co/v1/customers/{customerId}/onboarding-requests/{caseId}/documents/view-url \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "documents": [
    {
      "storageKey": "<string>"
    }
  ]
}
'

import requests

url = "https://api.blockradar.co/v1/customers/{customerId}/onboarding-requests/{caseId}/documents/view-url"

payload = { "documents": [{ "storageKey": "<string>" }] }
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({documents: [{storageKey: '<string>'}]})
};

fetch('https://api.blockradar.co/v1/customers/{customerId}/onboarding-requests/{caseId}/documents/view-url', 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.blockradar.co/v1/customers/{customerId}/onboarding-requests/{caseId}/documents/view-url",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'documents' => [
        [
                'storageKey' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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.blockradar.co/v1/customers/{customerId}/onboarding-requests/{caseId}/documents/view-url"

	payload := strings.NewReader("{\n  \"documents\": [\n    {\n      \"storageKey\": \"<string>\"\n    }\n  ]\n}")

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

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	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.blockradar.co/v1/customers/{customerId}/onboarding-requests/{caseId}/documents/view-url")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"documents\": [\n    {\n      \"storageKey\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.blockradar.co/v1/customers/{customerId}/onboarding-requests/{caseId}/documents/view-url")

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["Content-Type"] = 'application/json'
request.body = "{\n  \"documents\": [\n    {\n      \"storageKey\": \"<string>\"\n    }\n  ]\n}"

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

{
  "status": true,
  "message": "<string>",
  "data": {
    "caseId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "documents": [
      {
        "storageKey": "<string>",
        "viewUrl": "<string>",
        "expiresAt": "2023-11-07T05:31:56Z"
      }
    ]
  }
}

{
  "statusCode": 123,
  "message": "<string>",
  "details": {
    "code": "CUSTOMER_ONBOARDING_REQUIRED",
    "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "provider": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "slug": "<string>",
      "name": "<string>"
    },
    "onboarding": {
      "caseId": "<string>",
      "status": "<string>",
      "providerStatus": "<string>",
      "action": {
        "type": "create_case",
        "method": "POST",
        "path": "/v1/customers/18d2f159-e0cd-4a45-b735-e9dfe0f7520a/onboarding-requests",
        "body": {
          "provider": "<string>",
          "type": "onramp"
        }
      }
    }
  },
  "requestId": "<string>"
}

{
  "statusCode": 123,
  "message": "<string>",
  "details": {
    "code": "CUSTOMER_ONBOARDING_REQUIRED",
    "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "provider": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "slug": "<string>",
      "name": "<string>"
    },
    "onboarding": {
      "caseId": "<string>",
      "status": "<string>",
      "providerStatus": "<string>",
      "action": {
        "type": "create_case",
        "method": "POST",
        "path": "/v1/customers/18d2f159-e0cd-4a45-b735-e9dfe0f7520a/onboarding-requests",
        "body": {
          "provider": "<string>",
          "type": "onramp"
        }
      }
    }
  },
  "requestId": "<string>"
}

Create temporary preview links for documents already stored on this request. Use this only when your UI needs to display an uploaded document. The response contains data.caseId and data.documents, including each document’s viewUrl and expiresAt.

Authorizations

x-api-key

string

header

required

Path Parameters

customerId

string<uuid>

required

Customer identifier.

caseId

string<uuid>

required

Customer onboarding case identifier.

Body

application/json

documents

object[]

required

Show child attributes

Response

Customer onboarding request updated.

status

boolean

required

Example:

true

message

string

required

data

object

required

Show child attributes

API Documentation

Wallet

Addresses

Customer

Asset

Transactions

Withdraw

Withdraw Fiat

Signing

Swap

Liquidity Pool

Virtual Accounts

Deposit Fiat

Auto Settlements

Smart Contract

Gateway

Payment Links

AML

Asset Recovery

Miscellaneous

Rewards

Get document preview URLs

Authorizations

Path Parameters

Body

Response