v1

latestOpenAPI 3.0.02026-07-22243670.8 KB

Pii

Get PII for the authenticated partner and user

Returns the user's PII (full legal name, country of citizenship, tax ID, permanent address) to pre-fill tax forms such as the W-8BEN. Fields that are unavailable are null.

get/v1/pii

Response

Successful response.

date_of_birthstring date nullable required

Date of birth as an ISO 8601 date (YYYY-MM-DD). Null for companies and when unavailable.

full_legal_namestring nullable required

Full legal name. For persons: first, middle and last name joined. For companies: the company name.

kind'person' | 'company' required

Kind of the entity the PII belongs to

object'user_pii' required

String representing the object's type. Objects of the same type share the same value.

tax_idstring nullable required

Tax identification number. For persons: SSN or foreign TIN. For companies: EIN.

Example response

{
  "date_of_birth": "1990-01-15",
  "full_legal_name": "Aleksander Nowak",
  "jurisdiction": {
    "iso_2": "PL",
    "name": "Poland"
  },
  "kind": "person",
  "permanent_address": {
    "city": "Warsaw",
    "country": "PL",
    "postal_code": "00-001",
    "street": "ul. Nowy Świat 12"
  }
}