Skip to main content
GET
/
v1
/
beneficiaries
/
{id}
/
pii
Retrieve beneficiary PII
curl --request GET \
  --url https://api.antonpayments.com/v1/beneficiaries/{id}/pii \
  --header 'Authorization: Bearer <token>'
{
  "type": "individual",
  "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"
  },
  "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",
    "entity_type": "llc",
    "incorporation_country": "US",
    "incorporation_date": "<string>",
    "website": "https://example.de"
  }
}

Authorizations

​
Authorization
string
header
required

API keys are opaque strings prefixed by environment:

  • ak_live_* — production keys, accepted only on api.antonpayments.com.
  • ak_test_* — sandbox keys, accepted only on api.antonpayments.dev.

Include your key in the Authorization header: Bearer ak_test_....

Path Parameters

​
id
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.

​
business
object

PII for a business beneficiary. Tokenized on creation.