PrivyPrivy
Sign in
  • Documentation
Back to Documentation
B2B Digital Certificate Issuance
OverviewChangelog
Authoritative Partner Verification
    User Verification
      v2
        OverviewQuickstartEnvironmentsAuthenticationRequest FieldsVerification ResultsError Catalog
API Explorer
powered by Zudoku
Sign in
v2

Verification Results

Breaking change — effective 17 August 2026: Privy-Version: 2026-08-17.heimdall standardizes response field names and changes status from ok to success. New integrations must send this request header. Inspect the Privy-Version response header to identify your current version, and review the response changes and migration steps before adopting it.

A successful HTTP 200 response reports one of two business outcomes. Always check userStatus before continuing the registration flow.

userStatusMeaningAdditional field
verifiedThe digital certificate was issued.privy_id
rejectedThe digital certificate was held.rejected_code

Both outcomes contain the remaining integer balance, Privy's transaction_id, and a human-readable message.

Verified result

Code
{ "code": 200, "status": "ok", "userStatus": "verified", "privy_id": "ABC1234", "balance": 13, "transaction_id": "deabaaa2-73a1-46a6-9794-45d14a3be4f6", "message": "digital certificate has been issued" }

Rejected result

Code
{ "code": 200, "status": "ok", "userStatus": "rejected", "rejected_code": "R102", "balance": 12, "transaction_id": "ceeb66a2-ea88-9id7-9137-aa744a3dae775", "message": "digital certificate has been held" }

Treat rejected_code as the machine-readable rejection reason. Keep the code and transaction_id when you contact Privy or reconcile a rejected request.

Registration-status catalog

The source contract also documents these registration status codes. It does not identify them as a field in the verification response payload.

CodeMeaning
R200Registration succeeded.
R201Registration failed because the phone is used by another NIK.
R202Registration failed because the email is used by another NIK.
R203Registration failed because the phone and email are used by another NIK.

Do not substitute a registration status code for userStatus or infer that it will be present when the response contract does not include it.

Registration statuses when Phone Match is enabled

The following registration statuses apply only when Phone Match is enabled:

CodeMeaning
R200-1Registration succeeded with an additional telco phone and NIK check.
R201-1The phone is used by another NIK after the additional telco check.
Last modified on October 23, 2026
Request FieldsError Catalog
On this page
  • Verified result
  • Rejected result
  • Registration-status catalog
  • Registration statuses when Phone Match is enabled
JSON
JSON