How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Paxos Identity API

An Identity represents a person or institution who is able to take actions on the Paxos Platform. Depending on your integration type you might not need to create Identities for your end users. Identities must pass a set of verifications and checks before they're able to transact on the Platform. Learn moreabout getting started with Identity and managing their onboarding lifecycle in the [Identity Developer Guide](https://docs.paxos.com/identity).

Paxos Identity API is one of 43 APIs that Paxos publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Identity. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 4 operations across 2 paths, and defines 44 schemas. It is described by OpenAPI 3.0.0, at version 2.0.

Requests are made against 2 base URLs: https://api.paxos.com/v2, https://api.sandbox.paxos.com/v2.

4 operations 2 paths 44 schemas 2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2.0
Base URL
https://api.paxos.com/v2
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Paxos Identity API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the clientCredentials flow, exposing 36 scopes.

  • OAuth2 — Paxos APIs use [OAuth 2](https://tools.ietf.org/html/rfc6749) with the [client credentials](https://tools.ietf.org/html/rfc6749section-4.4) grant flow. Token U…

Paths & Operations 4

Across 2 paths, the API surfaces 4 operations — 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Identity 4

An Identity represents a person or institution who is able to take actions on the Paxos Platform. Depending on your integration type you might not need to create Identities for yo…

GET
/identity/identities
List Identities
ListIdentities 18 params → 200
POST
/identity/identities
Create Identity
CreateIdentity body → 200409
GET
/identity/identities/{id}
Get Identity
GetIdentity 3 params → 200
PUT
/identity/identities/{id}
Update Identity
UpdateIdentity 1 param body → 200

Schemas 44

The contract defines 44 schemas that model the data the API accepts and returns. The most detailed are PersonDetails (26 properties), InstitutionDetails (24 properties), Identity (20 properties), CustomerDueDiligence (16 properties). Each schema is shown below with its type and property counts.

IdentityControlReasonCode
string
- OTHER: Miscellaneous reason not captured by existing categories. - ENDUSERREQUEST: Control applied at the end user's request. - INACTIVITY: Control applied d…
IdentityStatusDetails
object
2 properties
InstitutionMember
object
7 properties 1 required
PassthroughVerificationField
string
IdentityMailingAddress
object
A mailing address.
6 properties 4 required
CustomerDueDiligenceTransferValueRange
string
Anticipated monthly volume. The expected transfer value range for the Account associated with the Identity.
IdentityRequirementRequirementStatus
string
RequirementStatus indicates whether this requirement is pending or has failed. PENDING means the check is in progress or awaiting information. FAILED means the…
IdentityRequirementRequirementType
string
RequirementType identifies the category of requirement blocking or pending for an identity. - IDVERIFICATION: Identity verification via a passthrough provider…
IdentityControlType
string
InstitutionSubType
string
IdentityType
string
InstitutionType
string
IdentityPublicUpdateIdentityBody
object
10 properties
PersonDetails
object
26 properties
MerchantFundingSourceFundingSource
string
IdentityRequirementError
object
A specific error explaining why a requirement is blocked or pending.
2 properties 2 required
Identity
object
20 properties 1 required
IdentityRequirementErrorCode
string
Code identifies the specific failure type. Additional codes may be added as new requirement types are introduced.
identityprotoVerifierType
string
AccountPurpose
string
CreateIdentityRequest
object
9 properties
PassthroughVerifierType
string
InstitutionDetails
object
24 properties
IdentityRequirement
object
A requirement that must be fulfilled for an identity to be onboarded, reinstated, or remain in good standing.
4 properties 3 required
TradingType
string
WealthSource
string
TaxDetail
object
3 properties
CustomerRegion
string
CustomerDueDiligenceNetWorthRange
string
IdentityRequirementAwaitingActionFrom
string
AwaitingActionFrom indicates who needs to take action to unblock this requirement. Not set for MEMBERS requirements, where the client should call GetIdentity o…
IdentityStatus
string
Problem
object
5 properties
CustomerDueDiligence
object
16 properties
RegulationStatus
string
EmploymentStatus
string
CustomerDueDiligenceYearlyIncomeRange
string
FundsSource
string
TINVerificationStatus
string
The TIN verification status for the associated taxpayerid.
IdentityControlSetBy
string
InstitutionCIPIDType
string
PersonDetailsCIPIDType
string
InstitutionRoleType
string
ListIdentitiesResponse
object
2 properties
IdentityControl
object
8 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

paxos-identity-api-openapi.yml Raw ↑

Other APIs Paxos publishes across the network.

Paxos Account Members API
Paxos Accounts API
Paxos Address Verification API
Paxos API Credentials API
Paxos Claims API
Paxos Crypto Deposits API
Paxos Crypto Withdrawals API
Paxos Deposit Addresses API
Paxos Events API
Paxos ExchangePublic API
Paxos Fees API
Paxos Fiat Transfers API
Where this information came from

This is an independent, third-party profile of Paxos Identity API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.