Create a Proof of Ownership PDF for an address

Creates a Proof of Ownership PDF for a blockchain address owned by the authenticated workspace — for example, to share with a counterparty or bank as compliance evidence. Recipients can confirm it with POST /v1/address_registry/proof_of_ownership_exports/verify.

Check proofOfOwnershipAvailable on GET /v1/address_registry/legal_entities/{address} first if you want to know whether create is likely to succeed.

POST

address_registry

proof_of_ownership_exports

TypeScript

const response: Promise<FireblocksResponse<AddressRegistryCreateProofOfOwnershipResponse>> = fireblocks.compliance.createAddressRegistryProofOfOwnership(complianceApiCreateAddressRegistryProofOfOwnershipRequest);

CompletableFuture<ApiResponse<AddressRegistryCreateProofOfOwnershipResponse>> response = fireblocks.compliance().createAddressRegistryProofOfOwnership(addressRegistryCreateProofOfOwnershipRequest, idempotencyKey);

curl --request POST \
  --url https://api.fireblocks.io/v1/address_registry/proof_of_ownership_exports \
  --header 'Content-Type: application/json' \
  --data '
{
  "address": "0x742d35cc6634c0532925a3b844bc9e7595f0beb0"
}
'

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({address: '0x742d35cc6634c0532925a3b844bc9e7595f0beb0'})
};

fetch('https://api.fireblocks.io/v1/address_registry/proof_of_ownership_exports', 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.fireblocks.io/v1/address_registry/proof_of_ownership_exports",
  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([
    'address' => '0x742d35cc6634c0532925a3b844bc9e7595f0beb0'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$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.fireblocks.io/v1/address_registry/proof_of_ownership_exports"

	payload := strings.NewReader("{\n  \"address\": \"0x742d35cc6634c0532925a3b844bc9e7595f0beb0\"\n}")

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

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.fireblocks.io/v1/address_registry/proof_of_ownership_exports")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"address\": \"0x742d35cc6634c0532925a3b844bc9e7595f0beb0\"\n}"

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

{
  "pdf": "JVBERi0xLjQK...",
  "exportId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "verificationHash": "BHS2QaqGyYegvLBy5qrGhrES3A2n5JPD7ubpgJozRgeA",
  "expiresAt": "2027-08-17"
}

{
  "message": "<string>",
  "code": 123
}

{
  "message": "<string>",
  "code": 123
}

{
  "message": "<string>",
  "code": 123
}

{
  "message": "<string>",
  "code": 123
}

{
  "message": "<string>",
  "code": 123
}

{
  "message": "<string>",
  "code": 123
}

{
  "message": "<string>",
  "code": 123
}

Headers

Idempotency-Key

string

A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.

Body

application/json

Request body for creating an Address Registry Proof of Ownership PDF export.

address

string

required

Blockchain address to prove ownership for (must resolve to the caller's workspace). Same format expectations as the address path parameter on GET /v1/address_registry/legal_entities/{address}.

Example:

"0x742d35cc6634c0532925a3b844bc9e7595f0beb0"

Response

PDF export created

Address Registry Proof of Ownership PDF export, created successfully.

pdf

string<byte>

required

Base64-encoded Proof of Ownership PDF bytes. Fireblocks does not store the PDF: save it immediately, there is no re-download route.

Example:

"JVBERi0xLjQK..."

exportId

string<uuid>

required

Stable id of the online-verifiable export record.

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

verificationHash

string

required

Verification hash bound to the export (also printed on the PDF).

Example:

"BHS2QaqGyYegvLBy5qrGhrES3A2n5JPD7ubpgJozRgeA"

expiresAt

string

required

Inclusive last UTC calendar day online verification is available (YYYY-MM-DD).

Example:

"2027-08-17"

⌘I

TypeScript

const response: Promise<FireblocksResponse<AddressRegistryCreateProofOfOwnershipResponse>> = fireblocks.compliance.createAddressRegistryProofOfOwnership(complianceApiCreateAddressRegistryProofOfOwnershipRequest);

CompletableFuture<ApiResponse<AddressRegistryCreateProofOfOwnershipResponse>> response = fireblocks.compliance().createAddressRegistryProofOfOwnership(addressRegistryCreateProofOfOwnershipRequest, idempotencyKey);

curl --request POST \
  --url https://api.fireblocks.io/v1/address_registry/proof_of_ownership_exports \
  --header 'Content-Type: application/json' \
  --data '
{
  "address": "0x742d35cc6634c0532925a3b844bc9e7595f0beb0"
}
'

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({address: '0x742d35cc6634c0532925a3b844bc9e7595f0beb0'})
};

fetch('https://api.fireblocks.io/v1/address_registry/proof_of_ownership_exports', 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.fireblocks.io/v1/address_registry/proof_of_ownership_exports",
  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([
    'address' => '0x742d35cc6634c0532925a3b844bc9e7595f0beb0'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$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.fireblocks.io/v1/address_registry/proof_of_ownership_exports"

	payload := strings.NewReader("{\n  \"address\": \"0x742d35cc6634c0532925a3b844bc9e7595f0beb0\"\n}")

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

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.fireblocks.io/v1/address_registry/proof_of_ownership_exports")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"address\": \"0x742d35cc6634c0532925a3b844bc9e7595f0beb0\"\n}"

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

{
  "pdf": "JVBERi0xLjQK...",
  "exportId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "verificationHash": "BHS2QaqGyYegvLBy5qrGhrES3A2n5JPD7ubpgJozRgeA",
  "expiresAt": "2027-08-17"
}

{
  "message": "<string>",
  "code": 123
}

{
  "message": "<string>",
  "code": 123
}

{
  "message": "<string>",
  "code": 123
}

{
  "message": "<string>",
  "code": 123
}

{
  "message": "<string>",
  "code": 123
}

{
  "message": "<string>",
  "code": 123
}

{
  "message": "<string>",
  "code": 123
}

Introduction

Errors & Statuses

Data Objects

API Endpoints

Create a Proof of Ownership PDF for an address

Headers

Body

Response