Overview

You can verify a counterparty via the POST /api/identity_verifications. This type of verification does not require initializing the Persona SDK, and is simple an API call. Counterparty verification runs the counterparty PII though watchlist screening. View the following POST body in the code block below:

{
  "type": "counterparty",
  "method": "watchlists",
  "counterparty_guid": "1e3ca10acd852d5f7d2662875253566c"
}

Parameters

type

The type is always counterparty.

method

The method is always watchlists

counter_party_guid

The guid of the counterparty you wish to verify.

When is counterparty verification complete?

After creating a counterparty identity verification, you can check the state and outcome of the identity verification using the GET /api/identity_verifications/{identity_verification_guid} endpoint.

state

The overall state of the counterparty identity verification.

storing

After creation the counterparty identity verification state will immediately progress from storing to pending.

pending

The counterparty identity verification is running watchlist checks. When the checks complete the state will progress to completed.

completed

The counterparty identity verification has completed and will return an outcome.

expired

The counterparty identity verification has expired before it could be completed. Create another counterparty identity verification.

outcome

The result of a completed counterparty identity verification.

passed

The counterparty identity verification has successfully passed, and the counterparty state will progress to verified.

failed

The counterparty identity verification has not passed. The failure_codes will be populated with any reason(s). Example: watchlist_check_failure if the individual or business is on a known government or international watchlist or sanctions list, they may show up on this report.