Skip to main content
POST
finance.credit-subject.create

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

Your identifier for the consenting person; it must match the resource owner.

Required string length: 1 - 256

The person agreed to this check and this use of their data.

purpose
enum<string>
required

The authorized purpose for a consumer report.

Available options:
account-review-credit,
account-review-non-credit,
extension-of-credit,
tenant-screening,
legitimate-business-need,
written-instruction-prequalification,
written-instruction-other,
government-benefits-eligibility
firstName
string
required

Given name.

Required string length: 1 - 100
lastName
string
required

Family name.

Required string length: 1 - 100
dateOfBirth
string<date>
required

Date as YYYY-MM-DD.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
emails
string<email>[]
required

Email addresses; first is primary.

Required array length: 1 - 3 elements

Email address.

Pattern: ^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
phones
string[]
required

Phone numbers; first is primary.

Required array length: 1 - 3 elements

International phone number.

Pattern: ^\+[1-9]\d{7,14}$
address
object
required

The person's address.

idNumberLast4
string

Optional last four identity number digits.

Pattern: ^\d{4}$

Response

The result

status
string
required

Operation state.

Allowed value: "active"
ref
string

Reference to what this call created. Pass it as ref to follow-up calls for this resource.