Create an account (reliance)

curl --request POST \
  --url https://app.crown-brlv.com/api/v1/accounts/reliance \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "individual",
  "identifier": {
    "value": "07051368923",
    "country": "BRA"
  },
  "tax-residence": "BRA",
  "kyc-attestation-id": "<string>",
  "reward-tier": 97,
  "external-wallets": [
    {
      "address": "0xabc...",
      "custody-country": "BRA",
      "custodian-name": "<string>"
    }
  ]
}
'

import requests

url = "https://app.crown-brlv.com/api/v1/accounts/reliance"

payload = {
    "type": "individual",
    "identifier": {
        "value": "07051368923",
        "country": "BRA"
    },
    "tax-residence": "BRA",
    "kyc-attestation-id": "<string>",
    "reward-tier": 97,
    "external-wallets": [
        {
            "address": "0xabc...",
            "custody-country": "BRA",
            "custodian-name": "<string>"
        }
    ]
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    type: 'individual',
    identifier: {value: '07051368923', country: 'BRA'},
    'tax-residence': 'BRA',
    'kyc-attestation-id': '<string>',
    'reward-tier': 97,
    'external-wallets': [{address: '0xabc...', 'custody-country': 'BRA', 'custodian-name': '<string>'}]
  })
};

fetch('https://app.crown-brlv.com/api/v1/accounts/reliance', 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://app.crown-brlv.com/api/v1/accounts/reliance",
  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([
    'type' => 'individual',
    'identifier' => [
        'value' => '07051368923',
        'country' => 'BRA'
    ],
    'tax-residence' => 'BRA',
    'kyc-attestation-id' => '<string>',
    'reward-tier' => 97,
    'external-wallets' => [
        [
                'address' => '0xabc...',
                'custody-country' => 'BRA',
                'custodian-name' => '<string>'
        ]
    ]
  ]),
  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://app.crown-brlv.com/api/v1/accounts/reliance"

	payload := strings.NewReader("{\n  \"type\": \"individual\",\n  \"identifier\": {\n    \"value\": \"07051368923\",\n    \"country\": \"BRA\"\n  },\n  \"tax-residence\": \"BRA\",\n  \"kyc-attestation-id\": \"<string>\",\n  \"reward-tier\": 97,\n  \"external-wallets\": [\n    {\n      \"address\": \"0xabc...\",\n      \"custody-country\": \"BRA\",\n      \"custodian-name\": \"<string>\"\n    }\n  ]\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))

}

HttpResponse<String> response = Unirest.post("https://app.crown-brlv.com/api/v1/accounts/reliance")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"individual\",\n  \"identifier\": {\n    \"value\": \"07051368923\",\n    \"country\": \"BRA\"\n  },\n  \"tax-residence\": \"BRA\",\n  \"kyc-attestation-id\": \"<string>\",\n  \"reward-tier\": 97,\n  \"external-wallets\": [\n    {\n      \"address\": \"0xabc...\",\n      \"custody-country\": \"BRA\",\n      \"custodian-name\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.crown-brlv.com/api/v1/accounts/reliance")

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  \"type\": \"individual\",\n  \"identifier\": {\n    \"value\": \"07051368923\",\n    \"country\": \"BRA\"\n  },\n  \"tax-residence\": \"BRA\",\n  \"kyc-attestation-id\": \"<string>\",\n  \"reward-tier\": 97,\n  \"external-wallets\": [\n    {\n      \"address\": \"0xabc...\",\n      \"custody-country\": \"BRA\",\n      \"custodian-name\": \"<string>\"\n    }\n  ]\n}"

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

{
  "account": {
    "id": "019712cf-c86d-703f-85b8-bdaa4fc8d254",
    "alias": "Trading account",
    "status": "active",
    "external-id": "ext-12345",
    "created-at": "2024-01-15T10:30:00Z",
    "parent-id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

{
  "account": {
    "id": "019712cf-c86d-703f-85b8-bdaa4fc8d254",
    "alias": "Trading account",
    "status": "active",
    "external-id": "ext-12345",
    "created-at": "2024-01-15T10:30:00Z",
    "parent-id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

{
  "error": {
    "type": "<string>",
    "message": "<string>",
    "code": "<string>"
  }
}

{
  "error": {
    "type": "<string>",
    "message": "<string>",
    "code": "<string>"
  }
}

{
  "error": {
    "type": "<string>",
    "message": "<string>",
    "code": "<string>"
  }
}

{
  "error": {
    "type": "<string>",
    "message": "<string>",
    "code": "<string>"
  }
}

Accounts

Create Account (Reliance)

Requests onboarding of an account, individual or company, whose KYC the partner has already completed and attests to. type says which the holder is.

Request-first: the response describes a creation request, not an account. The request enters compliance review and the account is provisioned on approval.

Every country code in the body is ISO 3166-1 alpha-3, read regardless of case: bra is read as BRA.

Validated on this request — every rule below is answered before anything is created:

The parent account must onboard accounts in reliance mode. A parent that onboards in kyc mode is refused with 403 and must use POST /v1/accounts/kyc/individual for an individual or POST /v1/accounts/kyc/company for a company.
The parent must hold the subaccounts-<tier>-tier capability matching reward-tier, or the request is refused with 403.
For an individual, identifier.country must be BRA exactly when tax-residence is BRA. A BRA identifier is a CPF and must be a valid one; any other country identifies the holder by the number that country issued them.
For a company, identifiers carries at most one entry per country, and at most one outside BRA.
A company whose tax-residence is BRA lists its CNPJ alone. A company resident abroad must list an entry under its tax-residence, and may add the CNPJ it also holds under BRA.
An entry under BRA must be a valid CNPJ and carries no type. Every entry outside BRA carries a type.
Addresses in external-wallets must be unique within the request, and none may already be registered to another account.

Idempotency: a request under the same parent with the same identifier number, whether pending, approved or active, is returned as-is with 200, instead of a second request being created. For a company, that number is the entry under its tax-residence.

POST

api

accounts

reliance

Create an account (reliance)

curl --request POST \
  --url https://app.crown-brlv.com/api/v1/accounts/reliance \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "individual",
  "identifier": {
    "value": "07051368923",
    "country": "BRA"
  },
  "tax-residence": "BRA",
  "kyc-attestation-id": "<string>",
  "reward-tier": 97,
  "external-wallets": [
    {
      "address": "0xabc...",
      "custody-country": "BRA",
      "custodian-name": "<string>"
    }
  ]
}
'

import requests

url = "https://app.crown-brlv.com/api/v1/accounts/reliance"

payload = {
    "type": "individual",
    "identifier": {
        "value": "07051368923",
        "country": "BRA"
    },
    "tax-residence": "BRA",
    "kyc-attestation-id": "<string>",
    "reward-tier": 97,
    "external-wallets": [
        {
            "address": "0xabc...",
            "custody-country": "BRA",
            "custodian-name": "<string>"
        }
    ]
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    type: 'individual',
    identifier: {value: '07051368923', country: 'BRA'},
    'tax-residence': 'BRA',
    'kyc-attestation-id': '<string>',
    'reward-tier': 97,
    'external-wallets': [{address: '0xabc...', 'custody-country': 'BRA', 'custodian-name': '<string>'}]
  })
};

fetch('https://app.crown-brlv.com/api/v1/accounts/reliance', 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://app.crown-brlv.com/api/v1/accounts/reliance",
  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([
    'type' => 'individual',
    'identifier' => [
        'value' => '07051368923',
        'country' => 'BRA'
    ],
    'tax-residence' => 'BRA',
    'kyc-attestation-id' => '<string>',
    'reward-tier' => 97,
    'external-wallets' => [
        [
                'address' => '0xabc...',
                'custody-country' => 'BRA',
                'custodian-name' => '<string>'
        ]
    ]
  ]),
  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://app.crown-brlv.com/api/v1/accounts/reliance"

	payload := strings.NewReader("{\n  \"type\": \"individual\",\n  \"identifier\": {\n    \"value\": \"07051368923\",\n    \"country\": \"BRA\"\n  },\n  \"tax-residence\": \"BRA\",\n  \"kyc-attestation-id\": \"<string>\",\n  \"reward-tier\": 97,\n  \"external-wallets\": [\n    {\n      \"address\": \"0xabc...\",\n      \"custody-country\": \"BRA\",\n      \"custodian-name\": \"<string>\"\n    }\n  ]\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))

}

HttpResponse<String> response = Unirest.post("https://app.crown-brlv.com/api/v1/accounts/reliance")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"individual\",\n  \"identifier\": {\n    \"value\": \"07051368923\",\n    \"country\": \"BRA\"\n  },\n  \"tax-residence\": \"BRA\",\n  \"kyc-attestation-id\": \"<string>\",\n  \"reward-tier\": 97,\n  \"external-wallets\": [\n    {\n      \"address\": \"0xabc...\",\n      \"custody-country\": \"BRA\",\n      \"custodian-name\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.crown-brlv.com/api/v1/accounts/reliance")

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  \"type\": \"individual\",\n  \"identifier\": {\n    \"value\": \"07051368923\",\n    \"country\": \"BRA\"\n  },\n  \"tax-residence\": \"BRA\",\n  \"kyc-attestation-id\": \"<string>\",\n  \"reward-tier\": 97,\n  \"external-wallets\": [\n    {\n      \"address\": \"0xabc...\",\n      \"custody-country\": \"BRA\",\n      \"custodian-name\": \"<string>\"\n    }\n  ]\n}"

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

{
  "account": {
    "id": "019712cf-c86d-703f-85b8-bdaa4fc8d254",
    "alias": "Trading account",
    "status": "active",
    "external-id": "ext-12345",
    "created-at": "2024-01-15T10:30:00Z",
    "parent-id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

{
  "account": {
    "id": "019712cf-c86d-703f-85b8-bdaa4fc8d254",
    "alias": "Trading account",
    "status": "active",
    "external-id": "ext-12345",
    "created-at": "2024-01-15T10:30:00Z",
    "parent-id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

{
  "error": {
    "type": "<string>",
    "message": "<string>",
    "code": "<string>"
  }
}

{
  "error": {
    "type": "<string>",
    "message": "<string>",
    "code": "<string>"
  }
}

{
  "error": {
    "type": "<string>",
    "message": "<string>",
    "code": "<string>"
  }
}

{
  "error": {
    "type": "<string>",
    "message": "<string>",
    "code": "<string>"
  }
}

Body

application/json

Individual
Company

A natural person, identified by the one register their country keeps

type

enum<string>

required

What the holder is. A BRA identifier is a CPF for an individual

Available options:

individual

Example:

"individual"

identifier

object

required

How the person is identified. Under BRA the value is their CPF; under every other country it is the number that country issued them

Show child attributes

tax-residence

string

required

Tax residence country, ISO-3

Example:

"BRA"

kyc-attestation-id

string

required

Partner's reference to its own completed KYC of the holder

reward-tier

enum<number>

required

CDI reward tier (%) for the account. The parent account must hold the matching subaccounts--tier capability.

Available options:

93.5,

90,

97

Example:

97

external-wallets

object[]

Show child attributes

Response

An equivalent non-terminal request already exists

account

object

required

Show child attributes

API documentation

Accounts

Orders

Quotes

Wallets

Transfers

NFT transfers

Withdrawals

Deposits

Balance

Claims

Auto-claims

Tax exemption

Webhooks

Create Account (Reliance)

Body

Response