curl --request PUT \
--url https://api.paxos.com/v2/identity/identities/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"id": "f190b163-208f-4d73-8deb-4fb8b24add00",
"person_details": {
"first_name": "John"
}
}
'import requests
url = "https://api.paxos.com/v2/identity/identities/{id}"
payload = {
"id": "f190b163-208f-4d73-8deb-4fb8b24add00",
"person_details": { "first_name": "John" }
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
id: 'f190b163-208f-4d73-8deb-4fb8b24add00',
person_details: {first_name: 'John'}
})
};
fetch('https://api.paxos.com/v2/identity/identities/{id}', 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/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'id' => 'f190b163-208f-4d73-8deb-4fb8b24add00',
'person_details' => [
'first_name' => 'John'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.paxos.com/v2/identity/identities/{id}"
payload := strings.NewReader("{\n \"id\": \"f190b163-208f-4d73-8deb-4fb8b24add00\",\n \"person_details\": {\n \"first_name\": \"John\"\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.put("https://api.paxos.com/v2/identity/identities/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"f190b163-208f-4d73-8deb-4fb8b24add00\",\n \"person_details\": {\n \"first_name\": \"John\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.paxos.com/v2/identity/identities/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"f190b163-208f-4d73-8deb-4fb8b24add00\",\n \"person_details\": {\n \"first_name\": \"John\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "f190b163-208f-4d73-8deb-4fb8b24add00",
"summary_status": "PENDING"
}Update Identity
Updates an Identity, this action performs a delta of what is submitted in the update and the existing identity.
- Updating details (
person_detailsorinstitution_details) might lead to the identity being re-verified (e.g. re-screening name changes), which could impact the identity’s ability to transact on the Platform. - Setting
set_user_disabledtotruewill make the IdentityDISABLED(read more here on what this means) - Setting
tax_detailswill update all the tax details for the identity - Setting
last_kyc_refresh_dateindicates this is not an adhoc-update, and instead an update for a periodic kyc refresh
Changing an Institution Identity to a Person and vice-versa is not supported.
curl --request PUT \
--url https://api.paxos.com/v2/identity/identities/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"id": "f190b163-208f-4d73-8deb-4fb8b24add00",
"person_details": {
"first_name": "John"
}
}
'import requests
url = "https://api.paxos.com/v2/identity/identities/{id}"
payload = {
"id": "f190b163-208f-4d73-8deb-4fb8b24add00",
"person_details": { "first_name": "John" }
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
id: 'f190b163-208f-4d73-8deb-4fb8b24add00',
person_details: {first_name: 'John'}
})
};
fetch('https://api.paxos.com/v2/identity/identities/{id}', 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/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'id' => 'f190b163-208f-4d73-8deb-4fb8b24add00',
'person_details' => [
'first_name' => 'John'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.paxos.com/v2/identity/identities/{id}"
payload := strings.NewReader("{\n \"id\": \"f190b163-208f-4d73-8deb-4fb8b24add00\",\n \"person_details\": {\n \"first_name\": \"John\"\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.put("https://api.paxos.com/v2/identity/identities/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"f190b163-208f-4d73-8deb-4fb8b24add00\",\n \"person_details\": {\n \"first_name\": \"John\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.paxos.com/v2/identity/identities/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"f190b163-208f-4d73-8deb-4fb8b24add00\",\n \"person_details\": {\n \"first_name\": \"John\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "f190b163-208f-4d73-8deb-4fb8b24add00",
"summary_status": "PENDING"
}identity:write_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
Body
Show child attributes
Show child attributes
Show child attributes
Show child attributes
true disables the identity. false re-enables it, unless it has been disabled by a Paxos admin.
Show child attributes
Show child attributes
A user-facing ID to prevent duplicate identity creation. Unique for all identities created by the same API user.
Show child attributes
Show child attributes
Set to true if tax details are not legally required. Must not be true when cip_id_country is USA.
Show child attributes
Show child attributes
Set to true to indicate that this identity is a merchant.
Set to the timestamp the identity has last undergone a periodic kyc refresh. If unset, the update is not for
periodic kyc refresh. RFC3339 format, like YYYY-MM-DDTHH:MM:SS.sssZ. ex: 2006-01-02T15:04:05Z.
Response
A successful response.
Show child attributes
Show child attributes
PENDING, ERROR, APPROVED, DENIED, DISABLED Show child attributes
Show child attributes
PENDING, ERROR, APPROVED, DENIED, DISABLED Deprecated: use status_details.active_controls instead.
Deprecated: use status_details.active_controls instead.
Show child attributes
Show child attributes
PERSON, INSTITUTION A user-facing ID to prevent duplicate account creation. Unique for all accounts created by the same API user.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The time at which the identity is created at. RFC3339 format, like YYYY-MM-DDTHH:MM:SS.sssZ. ex: 2006-01-02T15:04:05Z.
The time at which the identity is updated at. RFC3339 format, like YYYY-MM-DDTHH:MM:SS.sssZ. ex: 2006-01-02T15:04:05Z.
Show child attributes
Show child attributes
The TIN verification status for the associated tax_payer_id.
TIN_VERIFICATION_PENDING, TIN_VERIFICATION_ERROR, TIN_VERIFICATION_VALID Show child attributes
Show child attributes
True if the identity is a merchant.
The last timestamp the identity has undergone a periodic kyc refresh. RFC3339 format, like YYYY-MM-DDTHH:MM:SS.sssZ. ex: 2006-01-02T15:04:05Z.
Was this page helpful?