Create document address
curl --request POST \
--url https://api.beltic.com/v1/identity/documents/addresses \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"data": {
"attributes": {
"files": [
{
"filename": "<string>",
"content_type": "<string>",
"byte_size": 123,
"checksum": "<string>"
}
]
},
"relationships": {}
},
"meta": {
"auto_submit_for_processing": false
}
}
'import requests
url = "https://api.beltic.com/v1/identity/documents/addresses"
payload = {
"data": {
"attributes": { "files": [
{
"filename": "<string>",
"content_type": "<string>",
"byte_size": 123,
"checksum": "<string>"
}
] },
"relationships": {}
},
"meta": { "auto_submit_for_processing": False }
}
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({
data: {
attributes: {
files: [
{
filename: '<string>',
content_type: '<string>',
byte_size: 123,
checksum: '<string>'
}
]
},
relationships: {}
},
meta: {auto_submit_for_processing: false}
})
};
fetch('https://api.beltic.com/v1/identity/documents/addresses', 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.beltic.com/v1/identity/documents/addresses",
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([
'data' => [
'attributes' => [
'files' => [
[
'filename' => '<string>',
'content_type' => '<string>',
'byte_size' => 123,
'checksum' => '<string>'
]
]
],
'relationships' => [
]
],
'meta' => [
'auto_submit_for_processing' => false
]
]),
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.beltic.com/v1/identity/documents/addresses"
payload := strings.NewReader("{\n \"data\": {\n \"attributes\": {\n \"files\": [\n {\n \"filename\": \"<string>\",\n \"content_type\": \"<string>\",\n \"byte_size\": 123,\n \"checksum\": \"<string>\"\n }\n ]\n },\n \"relationships\": {}\n },\n \"meta\": {\n \"auto_submit_for_processing\": false\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.beltic.com/v1/identity/documents/addresses")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"data\": {\n \"attributes\": {\n \"files\": [\n {\n \"filename\": \"<string>\",\n \"content_type\": \"<string>\",\n \"byte_size\": 123,\n \"checksum\": \"<string>\"\n }\n ]\n },\n \"relationships\": {}\n },\n \"meta\": {\n \"auto_submit_for_processing\": false\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.beltic.com/v1/identity/documents/addresses")
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 \"data\": {\n \"attributes\": {\n \"files\": [\n {\n \"filename\": \"<string>\",\n \"content_type\": \"<string>\",\n \"byte_size\": 123,\n \"checksum\": \"<string>\"\n }\n ]\n },\n \"relationships\": {}\n },\n \"meta\": {\n \"auto_submit_for_processing\": false\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"type": "document/address",
"attributes": {
"classification_type": "<string>",
"is_valid": true,
"reasoning": "<string>",
"name": {
"first": "<string>",
"middle": "<string>",
"last": "<string>"
},
"document_number": "<string>",
"issue_date": "<string>",
"expiry_date": "<string>",
"issuing_authority": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"subdivision": "<string>",
"postal_code": "<string>",
"country_code": "<string>"
},
"nationality": "<string>",
"files": [
{
"id": "<string>",
"filename": "<string>",
"content_type": "<string>",
"url": "https://s3.amazonaws.com/...?X-Amz-Signature=...",
"byte_size": 123,
"checksum": "<string>"
}
],
"created_at": "<string>",
"submitted_at": "<string>",
"processed_at": "<string>"
},
"relationships": {
"account": {
"data": {
"type": "<string>",
"id": "<string>"
}
},
"session": {
"data": {
"type": "<string>",
"id": "<string>"
}
},
"verification": {
"data": {
"type": "<string>",
"id": "<string>"
}
}
}
},
"meta": {
"presigned_upload_urls": [
{
"file_id": "123e4567-e89b-12d3-a456-426614174000",
"url": "https://s3.amazonaws.com/beltic-documents/...",
"expires_in": 3600
}
]
}
}{
"errors": [
{
"status": "<string>",
"title": "<string>",
"detail": "<string>",
"id": "<string>",
"code": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>",
"header": "<string>"
},
"meta": {}
}
],
"meta": {}
}{
"errors": [
{
"status": "<string>",
"title": "<string>",
"detail": "<string>",
"id": "<string>",
"code": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>",
"header": "<string>"
},
"meta": {}
}
],
"meta": {}
}{
"errors": [
{
"status": "<string>",
"title": "<string>",
"detail": "<string>",
"id": "<string>",
"code": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>",
"header": "<string>"
},
"meta": {}
}
],
"meta": {}
}{
"errors": [
{
"status": "<string>",
"title": "<string>",
"detail": "<string>",
"id": "<string>",
"code": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>",
"header": "<string>"
},
"meta": {}
}
],
"meta": {}
}Identity API — Document Addresses (Legacy)
Create Document Address
Create a new proof of address document
POST
/
v1
/
identity
/
documents
/
addresses
Create document address
curl --request POST \
--url https://api.beltic.com/v1/identity/documents/addresses \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"data": {
"attributes": {
"files": [
{
"filename": "<string>",
"content_type": "<string>",
"byte_size": 123,
"checksum": "<string>"
}
]
},
"relationships": {}
},
"meta": {
"auto_submit_for_processing": false
}
}
'import requests
url = "https://api.beltic.com/v1/identity/documents/addresses"
payload = {
"data": {
"attributes": { "files": [
{
"filename": "<string>",
"content_type": "<string>",
"byte_size": 123,
"checksum": "<string>"
}
] },
"relationships": {}
},
"meta": { "auto_submit_for_processing": False }
}
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({
data: {
attributes: {
files: [
{
filename: '<string>',
content_type: '<string>',
byte_size: 123,
checksum: '<string>'
}
]
},
relationships: {}
},
meta: {auto_submit_for_processing: false}
})
};
fetch('https://api.beltic.com/v1/identity/documents/addresses', 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.beltic.com/v1/identity/documents/addresses",
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([
'data' => [
'attributes' => [
'files' => [
[
'filename' => '<string>',
'content_type' => '<string>',
'byte_size' => 123,
'checksum' => '<string>'
]
]
],
'relationships' => [
]
],
'meta' => [
'auto_submit_for_processing' => false
]
]),
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.beltic.com/v1/identity/documents/addresses"
payload := strings.NewReader("{\n \"data\": {\n \"attributes\": {\n \"files\": [\n {\n \"filename\": \"<string>\",\n \"content_type\": \"<string>\",\n \"byte_size\": 123,\n \"checksum\": \"<string>\"\n }\n ]\n },\n \"relationships\": {}\n },\n \"meta\": {\n \"auto_submit_for_processing\": false\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.beltic.com/v1/identity/documents/addresses")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"data\": {\n \"attributes\": {\n \"files\": [\n {\n \"filename\": \"<string>\",\n \"content_type\": \"<string>\",\n \"byte_size\": 123,\n \"checksum\": \"<string>\"\n }\n ]\n },\n \"relationships\": {}\n },\n \"meta\": {\n \"auto_submit_for_processing\": false\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.beltic.com/v1/identity/documents/addresses")
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 \"data\": {\n \"attributes\": {\n \"files\": [\n {\n \"filename\": \"<string>\",\n \"content_type\": \"<string>\",\n \"byte_size\": 123,\n \"checksum\": \"<string>\"\n }\n ]\n },\n \"relationships\": {}\n },\n \"meta\": {\n \"auto_submit_for_processing\": false\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"type": "document/address",
"attributes": {
"classification_type": "<string>",
"is_valid": true,
"reasoning": "<string>",
"name": {
"first": "<string>",
"middle": "<string>",
"last": "<string>"
},
"document_number": "<string>",
"issue_date": "<string>",
"expiry_date": "<string>",
"issuing_authority": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"subdivision": "<string>",
"postal_code": "<string>",
"country_code": "<string>"
},
"nationality": "<string>",
"files": [
{
"id": "<string>",
"filename": "<string>",
"content_type": "<string>",
"url": "https://s3.amazonaws.com/...?X-Amz-Signature=...",
"byte_size": 123,
"checksum": "<string>"
}
],
"created_at": "<string>",
"submitted_at": "<string>",
"processed_at": "<string>"
},
"relationships": {
"account": {
"data": {
"type": "<string>",
"id": "<string>"
}
},
"session": {
"data": {
"type": "<string>",
"id": "<string>"
}
},
"verification": {
"data": {
"type": "<string>",
"id": "<string>"
}
}
}
},
"meta": {
"presigned_upload_urls": [
{
"file_id": "123e4567-e89b-12d3-a456-426614174000",
"url": "https://s3.amazonaws.com/beltic-documents/...",
"expires_in": 3600
}
]
}
}{
"errors": [
{
"status": "<string>",
"title": "<string>",
"detail": "<string>",
"id": "<string>",
"code": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>",
"header": "<string>"
},
"meta": {}
}
],
"meta": {}
}{
"errors": [
{
"status": "<string>",
"title": "<string>",
"detail": "<string>",
"id": "<string>",
"code": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>",
"header": "<string>"
},
"meta": {}
}
],
"meta": {}
}{
"errors": [
{
"status": "<string>",
"title": "<string>",
"detail": "<string>",
"id": "<string>",
"code": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>",
"header": "<string>"
},
"meta": {}
}
],
"meta": {}
}{
"errors": [
{
"status": "<string>",
"title": "<string>",
"detail": "<string>",
"id": "<string>",
"code": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>",
"header": "<string>"
},
"meta": {}
}
],
"meta": {}
}Authorizations
API key for authentication. Access https://console.beltic.com/ to obtain your API key.
Body
application/json
Was this page helpful?
⌘I