Skip to main content
POST
people.age.check

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

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
dateOfBirth
string
required

Date of birth (YYYY-MM-DD).

Required string length: 1 - 512
minimumAge
integer

Minimum age to verify (default 18).

Required range: 0 <= x <= 1000000
referenceDate
string

Date to check against (default today).

Required string length: 1 - 512

Response

The result

dateOfBirthValid
boolean
required

True when date of birth valid.

ageDays
number

Age days: how many.

ageMonths
number

Age months.

ageYears
number

Age years.

daysUntilMinimum
number

Days until minimum.

minimumAgeChecked
number

Minimum age checked.

dateOfBirth
string

Date of birth, ISO 8601.

meetsMinimum
boolean

True when meets minimum.

referenceDate
string

Reference date, ISO 8601.