Skip to main content
POST
people.employment.registry-check

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
kind
enum<string>
required

Look up a mobile number or an employment registry number.

Available options:
phone,
registry-number
identifier
string
required

Ten-digit Indian mobile number or twelve-digit registry number.

Required string length: 1 - 12
Pattern: ^[0-9]{10,12}$
includeHistory
boolean
default:false

Request dated employment records; maximum estimate USD 1.14.

includeRegistryNumber
boolean
default:false

Return the registry number explicitly.

Response

The result

found
boolean
required

Whether the registry found a record.

results
object[]
required

Dated employment facts, without suitability scores or family/contact details.

Maximum array length: 100
registryNumber
string

Employment registry number, only when requested.