Skip to main content
POST
finance.credit-report.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
ref
string
required

The ref returned by banking.connection.start.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
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.

daysRequested
integer
required

Days of bank history to request, 180 to 731.

Required range: 180 <= x <= 731
modules
enum<string>[]

Sections to generate; private attribute sections are refused until their fields are published.

Required array length: 1 - 6 elements

Requested report section.

Available options:
base,
income,
cashflow,
score,
network,
partner
partnerModels
object[]

One to four distinct risk models, chosen when the report is created. Each is charged when the report is created, whether or not it is read.

Required array length: 1 - 4 elements

One chosen model and its version.

Response

The result

status
string
required

Operation state.

Allowed value: "pending"
ref
string

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