KycRequest

object

idrequired: Id
Opaque record id.
partyrequired: KycParty
namerequired: string
statusrequired: "created" | "link_sent" | "opened" | "consented" | "in_progress" | "review" | …
status_labelrequired: string
checksrequired: array of KycCheck
linkrequired: object
link.statusrequired: string
none | pending | sent | opened | revoked | expired | blocked
link.expires_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
link.invited_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
link.blocked_reasonrequired: string or null
consentrequired: object or null
The notice the person agreed to (its version) and when.
consent.versionrequired: string
consent.atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
resultrequired: object or null
result.verified_namerequired: string or null
result.dob_yearrequired: integer or null
Only the year of birth is kept.
result.aadhaar_maskedrequired: string or null
"XXXX XXXX 1234" — never the number.
result.aadhaar_sourcerequired: string or null
digilocker | offline_xml
result.pan_maskedrequired: string or null
"XXXXXX234F" — never the full PAN.
result.pan_statusrequired: string or null
valid | inoperative | invalid | not_found
result.pan_namerequired: string or null
result.name_matchrequired: string or null
match | partial | mismatch
result.name_match_scorerequired: integer or null
result.pan_name_match_scorerequired: integer or null
result.review_reasonsrequired: array of object
result.review_reasons[].keyrequired: string
result.review_reasons[].labelrequired: string
result.failurerequired: string or null
result.has_photorequired: boolean
result.purgedrequired: boolean
The photo and the partner’s answer were deleted (retention).
decisionrequired: object or null
decision.byrequired: object or null
decision.by.idrequired: Id
Opaque record id.
decision.by.namerequired: string
decision.noterequired: string
expires_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
completed_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
created_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
last_errorrequired: string or null
canrequired: object
can.resendrequired: boolean
can.cancelrequired: boolean
can.deciderequired: boolean

Example

{
  "id": "cmusrceel0000q7kaafxqi1om",
  "party": "landlord",
  "name": "string",
  "status": "created",
  "status_label": "string",
  "checks": [
    "aadhaar"
  ],
  "link": {
    "status": "string",
    "expires_at": "2026-10-06T05:30:00.000Z",
    "invited_at": "2026-10-06T05:30:00.000Z",
    "blocked_reason": "string"
  },
  "consent": {
    "version": "string",
    "at": "2026-10-06T05:30:00.000Z"
  },
  "result": {
    "verified_name": "string",
    "dob_year": 0,
    "aadhaar_masked": "string",
    "aadhaar_source": "string",
    "pan_masked": "string",
    "pan_status": "string",
    "pan_name": "string",
    "name_match": "string",
    "name_match_score": 0,
    "pan_name_match_score": 0,
    "review_reasons": [
      {
        "key": "string",
        "label": "string"
      }
    ],
    "failure": "string",
    "has_photo": true,
    "purged": true
  },
  "decision": {
    "by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "note": "string"
  },
  "expires_at": "2026-10-06T05:30:00.000Z",
  "completed_at": "2026-10-06T05:30:00.000Z",
  "created_at": "2026-10-06T05:30:00.000Z",
  "last_error": "string",
  "can": {
    "resend": true,
    "cancel": true,
    "decide": true
  }
}

{ "id": "cmusrceel0000q7kaafxqi1om", "party": "landlord", "name": "string", "status": "created", "status_label": "string", "checks": [ "aadhaar" ], "link": { "status": "string", "expires_at": "2026-10-06T05:30:00.000Z", "invited_at": "2026-10-06T05:30:00.000Z", "blocked_reason": "string" }, "consent": { "version": "string", "at": "2026-10-06T05:30:00.000Z" }, "result": { "verified_name": "string", "dob_year": 0, "aadhaar_masked": "string", "aadhaar_source": "string", "pan_masked": "string", "pan_status": "string", "pan_name": "string", "name_match": "string", "name_match_score": 0, "pan_name_match_score": 0, "review_reasons": [ { "key": "string", "label": "string" } ], "failure": "string", "has_photo": true, "purged": true }, "decision": { "by": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "note": "string" }, "expires_at": "2026-10-06T05:30:00.000Z", "completed_at": "2026-10-06T05:30:00.000Z", "created_at": "2026-10-06T05:30:00.000Z", "last_error": "string", "can": { "resend": true, "cancel": true, "decide": true } }