Create Request for a Report

post

https://api.edgescore.com/api/v1/ibv/requests

Request a report for a consumer.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Information about the consumer and the request

consumer_id

string

required

^[a-zA-Z0-9-_.]+$

A unique identifier provided by the client for each consumer.

application_id

string

A unique identifier of an application, such as a loan, used to build data analytics reports.

ssn

string

required

^\d{3}-\d{2}-\d{4}$

Social security number.

first_name

string

required

First name of the consumer.

middle_name

string

Middle name of the consumer.

last_name

string

required

Last name of the consumer.

birth_date

date

^\d{4}-\d{2}-\d{2}$

Date of birth.

full_address

string

Full consumer address, used when the address is not split into multiple fields.

street_address

string

Street number and name (address unit designator and number).

street_address2

string

Additional address line (e.g., suite number).

city

string

City.

state_code

string

enum

State abbreviation of the address

zip_code

string

^[0-9]{5}(?:-[0-9]{4})?$

Zip code; allows both 5-digit and 9-digit formats.

home_phone

string

^\d{3}-\d{3}-\d{4}$

Landline number.

mobile_phone

string

^\d{3}-\d{3}-\d{4}$

Mobile phone number.

string

required

\\A[^@\\s]+@[^@\\s]+\\z

Email address of the consumer.

secondary_email

string

\\A[^@\\s]+@[^@\\s]+\\z

Secondary email address of the consumer.

employer_name

string

Name of the consumer's employer.

secondary_employer_name

string

Name of the consumer's secondary employer.

bank_name

string

Name of the bank.

routing_number

string

^\d{9}$

Routing number of the account the consumer wants to use for IBV, used to pre-select the bank for verification.

account_number

string

Account number of the account specified by the consumer to use for IBV analysis.

debit_card_number

string

Number of the debit card.

additional_data

object

Additional data for data analytics based on agreements with clients.

reference_date

date

required

^\d{4}-\d{2}-\d{2}$

As of date for attribute and score calculation, used to evaluate recent account activities. Default is the current date.

partner_name

string

Name of the partner (required for partners only).

ibv_vendor

string

enum

Name of the IBV vendor

ibv_data

object

Raw IBV data obtained by the clients.

Responses

200Returns the report if transaction data was provided in the request. Otherwiase, returns request id, connection link, and url for retreiving report.

202Returns status of the report if transaction data was provided in the request, but report generation is pending.

400Bad Request - The request payload failed validation.