List Identity Documents
curl --request GET \
--url https://api.paxos.com/v2/identity/identities/{identity_id}/documents \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.paxos.com/v2/identity/identities/{identity_id}/documents"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.paxos.com/v2/identity/identities/{identity_id}/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.paxos.com/v2/identity/identities/{identity_id}/documents",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.paxos.com/v2/identity/identities/{identity_id}/documents"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.paxos.com/v2/identity/identities/{identity_id}/documents")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.paxos.com/v2/identity/identities/{identity_id}/documents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"documents": [
{
"file_id": "e1959b03-8c3d-4bdd-9437-403ccf8772f5",
"name": "test_file.png",
"document_types": [
"IDENTITY_VERIFICATION"
],
"created_at": "2023-07-07T23:03:19.170481Z",
"status": "COMPLETED_UPLOAD",
"required": true
},
{
"document_types": [
"PROOF_OF_RESIDENCY"
],
"status": "NOT_STARTED",
"required": true
}
]
}{
"detail": "Forbidden",
"status": 403,
"title": "Forbidden",
"type": "about:blank"
}{
"detail": "Identity with id f6b1365a-dc8e-4526-aa3f-e688826c36be doesn't exist",
"status": 404,
"title": "Not Found",
"type": "about:blank"
}Identity Documents
List Identity Documents
This endpoint enables you to get a list of all documents associated with an identity.
GET
/
identity
/
identities
/
{identity_id}
/
documents
List Identity Documents
curl --request GET \
--url https://api.paxos.com/v2/identity/identities/{identity_id}/documents \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.paxos.com/v2/identity/identities/{identity_id}/documents"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.paxos.com/v2/identity/identities/{identity_id}/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.paxos.com/v2/identity/identities/{identity_id}/documents",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.paxos.com/v2/identity/identities/{identity_id}/documents"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.paxos.com/v2/identity/identities/{identity_id}/documents")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.paxos.com/v2/identity/identities/{identity_id}/documents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"documents": [
{
"file_id": "e1959b03-8c3d-4bdd-9437-403ccf8772f5",
"name": "test_file.png",
"document_types": [
"IDENTITY_VERIFICATION"
],
"created_at": "2023-07-07T23:03:19.170481Z",
"status": "COMPLETED_UPLOAD",
"required": true
},
{
"document_types": [
"PROOF_OF_RESIDENCY"
],
"status": "NOT_STARTED",
"required": true
}
]
}{
"detail": "Forbidden",
"status": 403,
"title": "Forbidden",
"type": "about:blank"
}{
"detail": "Identity with id f6b1365a-dc8e-4526-aa3f-e688826c36be doesn't exist",
"status": 404,
"title": "Not Found",
"type": "about:blank"
}OAuth Scope
identity:read_identity
Authorizations
Paxos APIs use OAuth 2 with the client credentials grant flow.
Token URLs:
- Production: https://oauth.paxos.com/oauth2/token
- Sandbox: https://oauth.sandbox.paxos.com/oauth2/token
Learn more in the API credentials guide →
Path Parameters
id associated with the identity
Query Parameters
Add a list of pending document types for the identity
Response
A successful response.
Show child attributes
Show child attributes
Deprecated: selected-but-missing document types (required or optional) are
now represented as entries in documents with status = NOT_STARTED;
required types additionally carry required = true. Only populated when
include_pending_docs is set.
Available options:
OTHER_DOCUMENTS, APPLICATION, ORGANIZATIONAL_DOCUMENTS, CERTIFICATE_OF_GOOD_STANDING, TAX_IDENTIFICATION, IDENTITY_VERIFICATION, PROOF_OF_RESIDENCY, PROOF_OF_FUNDS, SAMPLE_INVOICE, OPERATING_AGREEMENT, TRUST_DOCUMENTS, MONEY_SERVICE_DOCUMENTS, INVESTMENT_DOCUMENTS, CURP, AML_DOCUMENTS, FUND_STRUCTURE_CHART, FUND_MANAGER_REGISTRATION, MEMORANDUM_OF_ASSOCIATION, ORGANIZATIONAL_CHART, FOUNDATION_BY_LAWS, APPOINTMENT_OF_GUARDIAN_EVIDENCE, LEGAL_DOMICILE_OF_BENEFICIAL_OWNERS, GOVERNING_BODY_MEMBER_NAMES, INDEPENDENT_AUDIT Was this page helpful?