Skip to content
PramaanDPDP Live
APIs and Webhooks

API error codes FAQ

How to read PRAMAAN problem-details errors and decide when to retry, fix input, or escalate.

Updated 3 min read

Overview

PRAMAAN API errors are designed to explain what failed without exposing personal data. Use status, type, title, detail, and correlation ID to route the issue.

What to do

Step 1: Treat 4xx as a client or consent-state issue unless the detail says otherwise.
Step 2: Treat 5xx as a retryable platform issue with backoff.
Step 3: Include correlation IDs in support tickets, not raw identity data.

json

Problem-details shape

{
  "type": "https://docs.pramaan.online/errors/consent-required",
  "title": "Consent required",
  "status": 409,
  "detail": "The data principal must approve this verification purpose first."
}

Frequently asked questions

Next step

Move safely from answer to action.

Map each error state to a user-safe message and a support-safe correlation ID.

Was this helpful?