Skip to main content
PUT
/
v2
/
identity
/
identities
/
{id}
{
  "id": "<string>",
  "customer_id": "<string>",
  "ref_id": "<string>",
  "identity_type": "PERSON",
  "status": "PENDING",
  "status_details": {
    "pending_verifications": {
      "message": "<string>",
      "metadata": {
        "statuses": [
          {
            "type": "IDV",
            "status": "PENDING"
          }
        ]
      }
    },
    "pending_edd": {
      "message": "<string>"
    },
    "pending_member_approvals": {
      "message": "<string>",
      "metadata": {
        "pending_members": [
          "<string>"
        ]
      }
    },
    "failed_verifications": {
      "message": "<string>",
      "metadata": {
        "statuses": [
          {
            "type": "IDV",
            "status": "FAILED"
          }
        ]
      }
    },
    "prohibited_risk_rating": {
      "message": "<string>"
    },
    "failed_controls": {
      "message": "<string>",
      "metadata": {
        "dormant": true,
        "frozen": true,
        "closed": true,
        "denied": true,
        "admin_controls": {
          "dormant": true,
          "frozen": true,
          "closed": true,
          "denied": true
        }
      }
    },
    "failed_members": {
      "message": "<string>",
      "metadata": {
        "failed_members": [
          "<string>"
        ]
      }
    }
  },
  "person_details": {
    "first_name": "<string>",
    "last_name": "<string>",
    "middle_name": "<string>",
    "date_of_birth": "2023-12-25",
    "address": {
      "street_address": "<string>",
      "street_address_2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "postal_code": "<string>",
      "country": "<string>"
    },
    "email_address": "<string>",
    "phone_number": "<string>",
    "country_of_citizenship": "<string>",
    "country_of_birth": "<string>",
    "ssn": "<string>",
    "occupation": "<string>",
    "identity_verification_status": "PENDING",
    "aml_screening_status": "PENDING"
  },
  "institution_details": {
    "legal_name": "<string>",
    "doing_business_as_name": "<string>",
    "address": {
      "street_address": "<string>",
      "street_address_2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "postal_code": "<string>",
      "country": "<string>"
    },
    "incorporation_date": "2023-12-25",
    "country_of_formation": "<string>",
    "industry_type": "<string>",
    "legal_entity_type": "<string>",
    "website": "<string>",
    "business_description": "<string>",
    "members": [
      {
        "first_name": "<string>",
        "last_name": "<string>",
        "title": "<string>",
        "ownership_percentage": 123,
        "date_of_birth": "2023-12-25",
        "address": {
          "street_address": "<string>",
          "street_address_2": "<string>",
          "city": "<string>",
          "state": "<string>",
          "postal_code": "<string>",
          "country": "<string>"
        },
        "ssn": "<string>",
        "is_control_person": true
      }
    ],
    "identity_verification_status": "PENDING",
    "aml_screening_status": "PENDING"
  },
  "tax_details": [
    {
      "tax_id": "<string>",
      "tax_id_type": "SSN",
      "country": "<string>",
      "verification_status": "PENDING"
    }
  ],
  "customer_due_diligence": {
    "source_of_funds": "<string>",
    "purpose_of_account": "<string>",
    "expected_activity_level": "LOW",
    "verification_status": "PENDING"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "metadata": {},
  "controls": {
    "available_actions": [
      "CRYPTO_WITHDRAWAL"
    ],
    "dormant": true,
    "frozen": true,
    "closed": true,
    "denied": true,
    "admin_controls": {
      "dormant": true,
      "frozen": true,
      "closed": true,
      "denied": true
    }
  }
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
id
string
required

The Identity ID

Body

application/json
​
person_details
object
​
metadata
object
​
controls
object

User-initiated control actions including freeze, dormant status, closure, and available action restrictions

​
institution_details
object
​
ref_id
string

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

​
tax_details
object[]

List of tax details associated with the identity

​
set_tax_details_not_required
boolean

Set to true if tax details are not legally required.

​
customer_due_diligence
object
​
is_merchant
boolean

Set to true to indicate that this identity is a merchant.

​
last_kyc_refresh_date
string<date-time>

Set to the timestamp the identity has last undergone a periodic kyc refresh. If unset, the update is not for periodic kyc refresh. RFC3339 format, like YYYY-MM-DDTHH:MM:SS.sssZ. ex: 2006-01-02T15:04:05Z.

Response

A successful response.

​
id
string

The unique identifier for the identity

​
customer_id
string

The customer ID associated with this identity

​
ref_id
string

External reference ID provided by the client

​
identity_type
enum<string>

The type of identity

Available options:
PERSON,
INSTITUTION
​
status
enum<string>

Overall status of the identity verification

Available options:
PENDING,
ERROR,
APPROVED,
DENIED,
DISABLED
​
status_details
object

Detailed status information including verification statuses

​
person_details
object
​
institution_details
object
​
tax_details
object[]
​
customer_due_diligence
object
​
created_at
string<date-time>
​
updated_at
string<date-time>
​
metadata
object
​
controls
object

Current control state and action restrictions applied to this identity