Sign in
Identity profiles

Unlink an identity profile

Unlinks an IdentityProfile from a LedgerAccount (flips the matching link to is_current=false).

delete/identity_profiles/{id}

Path parameters

idstring required
Example:idpf_xxxxxxxxxxxxx

The ID of the IdentityProfile to unlink.

Query parameters

ledger_account_idstring required

The ID of the LedgerAccount to unlink the identity profile from.

Example:ldgr_xxxxxxxxxxxxx

Response

A successful response

business_namestring nullable required

Business entity name. Present on business profiles.

business_structurestring nullable required

Reported legal structure of a business profile (e.g. corp, llc). Provider-specific values; present on business profiles.

countrystring nullable required

ISO 3166-1 alpha-2 country code reported by the identity provider, such as US or GB. For individuals this is the country of citizenship or residence; for businesses, the country of incorporation.

created_atstring date-time required

When the identity profile was first created.

date_of_birthstring nullable required

ISO date (YYYY-MM-DD) reported by the identity provider. Present on individual profiles.

emailstring nullable required

Email address reported by the identity provider. Typically present on individual profiles.

first_namestring nullable required

Individual's first name.

idstring required

The tag of the identity profile (idpf_xxx).

last_namestring nullable required

Individual's last name.

phonestring nullable required

Phone number reported by the identity provider. Typically present on individual profiles.

profile_typestring required

Whether this is an 'individual' or 'business' profile.

status'not_started' | 'pending' | 'approved' | 'rejected' required

Derived verification status for an identity profile.

updated_atstring date-time required

When the identity profile was last synced from a verification.

Example response

{
  "created_at": "2023-12-01T05:00:00.401Z",
  "id": "idpf_xxxxxxxxxxxxx",
  "linked_companies": [
    {
      "id": "biz_xxxxxxxxxxxxxx",
      "title": "Pickaxe"
    }
  ],
  "updated_at": "2023-12-01T05:00:00.401Z",
  "verifications": [
    {
      "created_at": "2023-12-01T05:00:00.401Z",
      "id": "verf_xxxxxxxxxxxxx",
      "last_error_reason": "Document image was too blurry to read.",
      "session_url": "https://verify.stripe.com/session/abc123"
    }
  ]
}

Changes