API Reference
  1. KYC Verification API
  2. KYC

Verify an identity

post
https://pentrrawallet.com/api/v1/verify-kyc
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Submit KYC Verification

Submits an identity verification request. In live mode, all verification checks are performed automatically and a decision is returned synchronously. In sandbox mode, no checks are performed and the response always returns approved with a simulated face match score of 99.90. No balance is deducted in sandbox mode.

Document Requirements (Live Mode)

The idImage URL must point to a clear, well-lit, unobstructed photo of a valid government-issued identity document. The document must:

  • Be a valid, non-expired passport, national identity card, or driver license
  • Contain a visible photo of the document holder (for biometric comparison)
  • Be unmodified no digital editing, screenshots, or photocopies
  • Have a minimum resolution of 200x150 pixels

Selfie Requirements (Live Mode)

The userPhoto URL must point to a clear selfie of the person. The selfie must show a single face, eyes open, no sunglasses, and be well-lit with the face clearly visible and not partially covered.

Supported Country Codes

The countryCode field accepts ISO 3166-1 alpha-2 codes for supported countries only. Unsupported codes return HTTP 422. Sanctioned jurisdictions (Cuba, Iran, North Korea, Syria, Crimea, Donetsk, Luhansk) return a rejected outcome.

ID Type Matching

The idType submitted must match the actual document type detected on the idImage. Submitting passport while providing a national ID card results in a rejected outcome.

IP Restriction

In live mode, requests must originate from a whitelisted IP address. sandbox mode has no IP restriction.

Body Params
string
required

Your PentrraWallet public API key.

string
required

Your PentrraWallet secret key. Keep this confidential.

string
enum
Defaults to live

live performs real identity verification. IP whitelist enforced. Fees apply. sandbox simulates the process. Always returns approved. No fees. Defaults to live.

Allowed:
string
required

Person's first name. Must match the name on the submitted identity document.

string
required

Person's last name. Must match the name on the submitted identity document.

date
required

Date of birth in YYYY-MM-DD format. Must match what appears on the identity document. The person must be at least 18 years old.

string
enum
required

Type of identity document being submitted. Must match the actual document type in idImage. Mismatches result in a rejected outcome.

Allowed:
string
required

The identity document number (passport number, national ID number, etc.). Must match what appears on the submitted document.

string
required

Full physical address of the person. Used for sanctioned jurisdiction screening. Addresses mentioning sanctioned countries or regions result in a rejected outcome.

string
required
length between 2 and 2

ISO 3166-1 alpha-2 country code (2 uppercase letters) of the country that issued the identity document. Must match the country visible on the document. Sanctioned country codes result in a rejected outcome. Unsupported codes return HTTP 422.

uri
required

Publicly accessible URL of the identity document photo. Must be a valid, non-expired government-issued ID (passport, national identity card, or driver license). Must be an authentic, unaltered JPEG or PNG image. Minimum 200x150 pixels.

uri
required

Publicly accessible URL of the person's selfie photo. Must show a single face, eyes open, no sunglasses, face not partially covered, well-lit, and clearly visible.

Responses

Updated about 1 month ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago

Did this page help you?