Retrieve Beneficiary PII - Anton Payments

GET

beneficiaries

{id}

pii

Retrieve beneficiary PII

curl --request GET \
  --url https://api.antonpayments.com/v1/beneficiaries/{id}/pii \
  --header 'Authorization: Bearer <token>' \
  --header 'DPoP: <api-key>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>', DPoP: '<api-key>'}};

fetch('https://api.antonpayments.com/v1/beneficiaries/{id}/pii', 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.antonpayments.com/v1/beneficiaries/{id}/pii",
  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>",
    "DPoP: <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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.antonpayments.com/v1/beneficiaries/{id}/pii"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("DPoP", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "individual": {
    "first_name": "Jane",
    "last_name": "Smith",
    "email": "jane@example.com",
    "phone": "+442079460000",
    "date_of_birth": "1988-05-12",
    "nationality": "US",
    "address": {
      "street_line_1": "10 Example Street",
      "city": "London",
      "postal_code": "SW1A 1AA",
      "country": "US",
      "street_line_2": "Apt 4B",
      "state": "Greater London"
    },
    "middle_name": "R",
    "tax_id": "123-45-6789"
  },
  "business": {
    "legal_name": "Example GmbH",
    "registration_number": "HRB12345",
    "email": "jsmith@example.com",
    "phone": "+493012345678",
    "address": {
      "street_line_1": "10 Example Street",
      "city": "London",
      "postal_code": "SW1A 1AA",
      "country": "US",
      "street_line_2": "Apt 4B",
      "state": "Greater London"
    },
    "trading_name": "Example",
    "tax_id": "DE123456789",
    "incorporation_country": "US",
    "incorporation_date": "<string>",
    "website": "https://example.de"
  }
}

Authorizations

Authorization

string

header

required

OAuth 2.0 client_credentials grant (RFC 6749 §4.4) bound to a DPoP keypair (RFC 9449).

Flow (every authenticated /v1 call requires both an access token AND a fresh per-request DPoP proof):

Register a credential via the merchant portal. Anton issues a client_id (ant_oc_<env>_<32hex>) and a client_secret (ant_ocs_<env>_<48hex>, shown ONCE). The portal generates an ES256 or Ed25519 DPoP keypair in your browser; you store the private half.
Mint an access token: POST /oauth/token with Authorization: Basic <client_id:client_secret> and Content-Type: application/x-www-form-urlencoded. Body: grant_type=client_credentials. A DPoP header carrying a proof signed for the token endpoint is required (no ath claim on this proof).
Use the token: send Authorization: DPoP <access_token> plus a fresh DPoP: <proof> header on every /v1 request. The proof JWT MUST carry htm (request method), htu (request URL, no query/fragment), iat (within ±60s), jti (unique within 5 min), and ath (SHA-256 of the access token, base64url).

Tokens expire in 1 hour in production / staging and 8 hours in sandbox. There are no refresh tokens — call /oauth/token again with your secret. Anton's public signing key is published at /.well-known/jwks.json.

OpenAPI 3.0 has no native DPoP scheme; this declaration plus dpopHeader together convey both the access-token Authorization and the per-request proof header.

DPoP

string

header

required

Per-request DPoP proof JWT (RFC 9449). MUST accompany the Authorization: DPoP <access_token> header on every protected operation. The proof is signed by the merchant's private DPoP key and carries htm, htu, iat, jti, and ath claims.

Path Parameters

string

required

Pattern: ^ben_[a-zA-Z0-9]+$

Response

Beneficiary PII, detokenized.

Detokenized PII for a beneficiary. Returned by GET /v1/beneficiaries/{id}/pii. Exactly one of individual or business is populated matching the beneficiary's type.

type

enum<string>

Available options:

individual,

business

individual

object

PII for an individual beneficiary. Tokenized on creation.

Show child attributes

business

object

PII for a business beneficiary. Tokenized on creation.

Show child attributes

Replace Beneficiary PIIReplaces the PII stored in Basis Theory for this beneficiary. The entire PII blob is replaced — partial updates are not supported, because tokens are immutable. Supply the detail block matching the beneficiary's `type` (`individual` or `business`). The `display_name` on the beneficiary record is automatically re-derived from the new PII.

⌘I

Retrieve beneficiary PII

curl --request GET \
  --url https://api.antonpayments.com/v1/beneficiaries/{id}/pii \
  --header 'Authorization: Bearer <token>' \
  --header 'DPoP: <api-key>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>', DPoP: '<api-key>'}};

fetch('https://api.antonpayments.com/v1/beneficiaries/{id}/pii', 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.antonpayments.com/v1/beneficiaries/{id}/pii",
  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>",
    "DPoP: <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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.antonpayments.com/v1/beneficiaries/{id}/pii"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("DPoP", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "individual": {
    "first_name": "Jane",
    "last_name": "Smith",
    "email": "jane@example.com",
    "phone": "+442079460000",
    "date_of_birth": "1988-05-12",
    "nationality": "US",
    "address": {
      "street_line_1": "10 Example Street",
      "city": "London",
      "postal_code": "SW1A 1AA",
      "country": "US",
      "street_line_2": "Apt 4B",
      "state": "Greater London"
    },
    "middle_name": "R",
    "tax_id": "123-45-6789"
  },
  "business": {
    "legal_name": "Example GmbH",
    "registration_number": "HRB12345",
    "email": "jsmith@example.com",
    "phone": "+493012345678",
    "address": {
      "street_line_1": "10 Example Street",
      "city": "London",
      "postal_code": "SW1A 1AA",
      "country": "US",
      "street_line_2": "Apt 4B",
      "state": "Greater London"
    },
    "trading_name": "Example",
    "tax_id": "DE123456789",
    "incorporation_country": "US",
    "incorporation_date": "<string>",
    "website": "https://example.de"
  }
}