Sandbox Set Identity Status

Set the various statuses for the given Identity. To enable the Person Identity to transact, set both id_verification_status and sanctions_verification_status to "APPROVED". To enable the Institution to transact, set both sanctions_verification_status to "APPROVED". This endpoint also allows you to set the statuses for document_verification_status and additional_screening_status

PUT /identity/identities/{id}/sandbox-status

Sandbox Set Identity Status

cURL

curl --request PUT \
  --url https://api.paxos.com/v2/identity/identities/{id}/sandbox-status \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "f190b163-208f-4d73-8deb-4fb8b24add00",
  "id_verification_status": "APPROVED",
  "sanctions_verification_status": "APPROVED"
}
'

import requests

url = "https://api.paxos.com/v2/identity/identities/{id}/sandbox-status"

payload = {
    "id": "f190b163-208f-4d73-8deb-4fb8b24add00",
    "id_verification_status": "APPROVED",
    "sanctions_verification_status": "APPROVED"
}
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',
    id_verification_status: 'APPROVED',
    sanctions_verification_status: 'APPROVED'
  })
};

fetch('https://api.paxos.com/v2/identity/identities/{id}/sandbox-status', 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}/sandbox-status",
  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',
    'id_verification_status' => 'APPROVED',
    'sanctions_verification_status' => 'APPROVED'
  ]),
  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}/sandbox-status"

	payload := strings.NewReader("{\n  \"id\": \"f190b163-208f-4d73-8deb-4fb8b24add00\",\n  \"id_verification_status\": \"APPROVED\",\n  \"sanctions_verification_status\": \"APPROVED\"\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}/sandbox-status")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"id\": \"f190b163-208f-4d73-8deb-4fb8b24add00\",\n  \"id_verification_status\": \"APPROVED\",\n  \"sanctions_verification_status\": \"APPROVED\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.paxos.com/v2/identity/identities/{id}/sandbox-status")

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  \"id_verification_status\": \"APPROVED\",\n  \"sanctions_verification_status\": \"APPROVED\"\n}"

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

200

{}

OAuth Scope

identity:write_identity

Authorizations

Authorization · string · header · required

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 · string · required

Body

application/json

id_verification_status · enum<string>

Available options: PENDING, ERROR, APPROVED, DENIED, DISABLED

sanctions_verification_status · enum<string>

Available options: PENDING, ERROR, APPROVED, DENIED, DISABLED

user_disabled · object

Show child attributes

admin_disabled · object

Show child attributes

document_verification_status · enum<string>

Available options: PENDING, ERROR, APPROVED, DENIED, DISABLED

additional_screening_status · enum<string>

Available options: PENDING, ERROR, APPROVED, DENIED, DISABLED

Response

200 - application/json

A successful response.

The response is of type object.