Skip to main content
GET
/
identity
/
identities
/
{id}
{
  "id": "f190b163-208f-4d73-8deb-4fb8b24add00",
  "status": "DISABLED",
  "status_details": {
    "active_controls": [
      {
        "id": "59b8e3c5-2b6e-4fa6-afcf-8c685598241d",
        "type": "CLOSED",
        "controlled_by": "CLIENT",
        "reason_code": "END_USER_REQUESTED",
        "reason": "some client-set reason",
        "created_at": "2006-01-02T15:04:05Z"
      },
      {
        "id": "5f1eb60c-b292-482c-96fe-9e3e265abcd4",
        "type": "CLOSED",
        "controlled_by": "PAXOS",
        "reason_code": "OTHER",
        "reason": "some admin-set reason",
        "created_at": "2006-01-02T15:04:05Z"
      }
    ],
    "pending_requirements": [
      {
        "type": "ID_VERIFICATION",
        "message": "Pending ID Verification"
      },
      {
        "type": "SANCTIONS_SCREENING",
        "message": "Pending Sanctions Screening"
      },
      {
        "type": "ADDITIONAL_SCREENING",
        "message": "Pending PEP/Adverse Media Screening"
      },
      {
        "type": "MEMBERS",
        "message": "Pending members",
        "metadata": {
          "f190b163-208f-4d73-8deb-000000000001": "PENDING"
        }
      }
    ],
    "failed_requirements": [
      {
        "type": "ENHANCED_DUE_DILIGENCE",
        "message": "Failed Enhanced Due Diligence checks"
      },
      {
        "type": "RISK_AWARENESS_ASSESSMENT",
        "message": "Failed Risk Awareness Assessment"
      },
      {
        "type": "DISABLED_MEMBERS",
        "message": "Disabled members",
        "metadata": {
          "f190b163-208f-4d73-8deb-000000000002": "DISABLED"
        }
      },
      {
        "type": "RISK_RATING",
        "message": "Jurisdiction not supported by Paxos"
      }
    ]
  }
}
OAuth Scope
identity:read_identity

Path Parameters

​
id
string
required

id associated with the identity

Query Parameters

​
include_details
boolean

query param; details are encrypted, so we do not want to include them by default

​
include_institution_members
boolean

query param; to include institution members for institution identity

Response

200 - application/json

A successful response.

​
id
string
required
​
metadata
object
​
summary_status
enum<string>
Available options:
PENDING,
ERROR,
APPROVED,
DENIED,
DISABLED
​
user_disabled
boolean
​
admin_disabled
boolean
​
person_details
object
​
type
enum<string>
Available options:
PERSON,
INSTITUTION
​
ref_id
string

A user-facing ID to prevent duplicate account creation. Unique for all accounts created by the same API user.

​
institution_details
object
​
institution_members
members associated with institution identity type · object[]
​
created_at
string<date-time>

The time at which the identity is created at. RFC3339 format, like YYYY-MM-DDTHH:MM:SS.sssZ. ex: 2006-01-02T15:04:05Z.

​
updated_at
string<date-time>

The time at which the identity is updated at. RFC3339 format, like YYYY-MM-DDTHH:MM:SS.sssZ. ex: 2006-01-02T15:04:05Z.

​
tax_details
tax payer details · object[]
​
tax_details_not_required
boolean
​
summary_tin_verification_status
enum<string>

The TIN verification status for the associated tax_payer_id.

Available options:
TIN_VERIFICATION_PENDING,
TIN_VERIFICATION_ERROR,
TIN_VERIFICATION_VALID
​
customer_due_diligence
object
​
is_merchant
boolean

True if the identity is a merchant.

​
last_kyc_refresh_date
string<date-time>

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.

​
status
enum<string>
Available options:
PENDING,
ERROR,
APPROVED,
DENIED,
DISABLED
​
status_details
object