Using EDGE Lead Screening
Submit an inquiry to check against Edge's credit reports
Checks if the consumer in a lead has an existing Edge credit report with a POST request to:
https://api.edgescore.com/api/v1/inquiries/inquiry
Header
| Name | Description | Example | Required |
|---|---|---|---|
| x-api-key | A unique API Key for the environment | 19YYgyZecTaSs2N0gjlq32Vh6D | Yes |
| Content-Type | The format the data should be displayed in | application/json | Yes |
Body
Name | Description | Example | Type | Expected Format | Required |
|---|---|---|---|---|---|
client_inquiry_id | A unique identifier provided by the client for each consumer. The same ID that was used to generate the access token | 123456 | String | Yes | |
identity_tin | Identity's Social Security Number (SSN) | 111-11-1111 | String | Yes | |
identity_first_name | Identity's first name | John | String | Yes | |
identity_last_name | Identity's first name | Smith | String | Yes | |
Identity's Email Address | String | Yes | |||
identity_middle_name | First name of the consumer | John | String | No | |
identity_name_suffix | First name of the consumer | John | String | No | |
identity_birth_date | Date and time in ISO 8601 format | 2023-11-12 | String | YYYY-MM-DD | No |
mobile_phone | Identity's Mobile Phone Number | 546-889-2514 | String | No | |
home_phone | Identity's Home Phone Number | 546-889-2515 | String | No | |
work_phone | Identity's Work Phone Number | 546-889-2516 | String | No | |
work_phone_ext | Extension to Identity's Work Phone Number | 403 | String | No | |
bank_routing_number | Routing number of the account the consumer wants to use for IBV. Used to pre-select bank for verification | 000111449 or 074000101. | String | /^\d9$/ | No |
bank_account_number | Account number of the account specified by the consumer to use for IBV analysis | 523423512 | String | /^[0-9]*$/ | No |
drivers_license | Identities Driver's License number | M532-2252-2421 | String | No | |
drivers_license_state | State abbreviation for the driver's license state | IL | String | No | |
drivers_license_issued | Date and time in ISO 8601 format in which Driver's License was issued | 2023-11-12 | String | YYYY-MM-DD | No |
drivers_license_expired | Date and time in ISO 8601 format in which Driver's License will expire | 2023-11-15 | String | YYYY-MM-DD | No |
stated_income_min | Object where minimum income information is passed | "stated_income_min": { "currency": "USD", "amount": 50000, } | Object | No | |
stated_income_max | Object where maximum income information is passed | "stated_income_max": { "currency": "USD", "amount": 100000, } | Object | No | |
ip_address | IP address for Identity | 192.168.1.255 | String | \b(?:[0-9]3.)3[0-9]3\b | No |
Example
{
"client_inquiry_id": "abc123",
"identity_first_name": "abc",
"identity_last_name": "vivor",
"identity_tin": "255-57-4443",
"mobile_phone": "+14155552671",
"email": "[email protected]",
"bank_account_number": "389118445556",
"bank_routing_number": 31101279,
"ip_address": "107.115.203.73"
}Response
{
"client_id": "02e1cf2fe6f96256de70",
"client_inquiry_id": "abc123",
"credit_report_id": "IBVBDFC6819A8CB15A71CE9",
"credit_report_date": "2024-11-11T20:43:52Z",
"email_identities_count": 1,
"phone_identities_count": 1,
"bank_account_identities_count": 2,
"govID_identities_count": 0,
"identity_emails_count": 1,
"identity_phones_count": 1,
"identity_bank_accounts_count": 2,
"identity_govIDs_count": 0
}Retrieve Credit Report Preview
Retrieve a an income preview of a consumer defined using the credit_report_id by using a GET request to:
https://api.edgescore.com/api/v1/inquiries/preview/{credit_report_id}
Header
| Name | Description | Example | Required |
|---|---|---|---|
| x-api-key | A unique API Key for the environment | 19YYgyZecTaSs2N0gjlq32Vh6D | Yes |
| Content-Type | The format the data should be displayed in | application/json | Yes |
Path Parameters
| Name | Description | Example | Required |
|---|---|---|---|
| credit_report_id | Unique identifier that defines the consumer's EDGE report | IBVBDFC6819A8CB15A71CE9 | Yes |
Example
{
"client_id": "02e1cf2fe6f96256de70",
"credit_report_id": "IBVBDFC6819A8CB15A71CE9",
"credit_report_date": "2024-11-11T20:44:01Z",
"bank_routing_number": 61000228,
"bank_account_number_last_4": "8915",
"monthly_income_min": 5000,
"monthly_income_max": 10000,
"payroll_providers": [
"CAPITAL ONE TRANSFER RT0\n RHONDA VIVOR"
]
}You can adjust the styling of the iframe to match your application’s design system. Clients have full control to apply inline styles or use CSS classes for positioning, borders, sizing, and more to ensure a seamless visual fit within their user experience.
Retrieve Full Credit Report
Retrieve a an income preview of a consumer defined using the credit_report_id by using a GET request to:
https://api.edgescore.com/api/v1/inquiries/preview/{credit_report_id}
Header
| Name | Description | Example | Required |
|---|---|---|---|
| x-api-key | A unique API Key for the environment | 19YYgyZecTaSs2N0gjlq32Vh6D | Yes |
| Content-Type | The format the data should be displayed in | application/json | Yes |
Path Parameters
| Name | Description | Example | Required |
|---|---|---|---|
| credit_report_id | Unique identifier that defines the consumer's EDGE report | IBVBDFC6819A8CB15A71CE9 | Yes |
Response
{
"client_id": "02e1cf2fe6f96256de70",
"credit_report_id": "IBVBDFC6819A8CB15A71CE-",
"credit_report_date": "2024-11-11T20:44:01Z",
"attribute_values": [
[
"ninjaedge_uwcore_feature_38",
"identity.ibv_report_loan_payments"
],
[
"score_general",
"584.0"
],
[
"ninjaedge_voi_feature_15",
"False"
],
[
"ninjaedge_voi_feature_18",
"False"
],
[
"ninjaedge_voi_feature_23",
"2.303"
],
[
"ninjaedge_voiexp_feature_8",
"32059.71"
],
[
"ninjaedge_voi_feature_11",
"1"
],
[
"ninjaedge_voiexp_feature_7",
"590.88"
],
[
"ninjaedge_voi_feature_22",
"7"
],
[
"ninjaedge_loan_feature_237",
"181.51"
],
[
"ninjaedge_voi_feature_19",
"True"
],
[
"ninjaedge_loan_feature_233",
"313.58"
],
[
"ninjaedge_voiexp_feature_1",
"79.14"
],
[
"ninjaedge_uwcore_feature_12",
"46"
],
[
"ninjaedge_voi_feature_13",
"1.4"
],
[
"ninjaedge_voi_feature_10",
"0.0"
],
[
"ninjaedge_voi_feature_8",
"122.09"
],
[
"ninjaedge_voi_feature_5",
"80.61"
],
[
"ninjaedge_uwcore_feature_26",
"28.0"
],
[
"ninjaedge_voi_feature_24",
"CAPITAL ONE TRANSFER RT0\n RHONDA VIVOR"
],
[
"ninjaedge_uwcore_feature_10",
"10"
],
[
"ninjaedge_uwcore_feature_13",
"-8.09"
],
[
"ninjaedge_uwcore_feature_1",
"10"
],
[
"ninjaedge_voiexp_feature_2",
"1306.78"
],
[
"score_general_factor_0",
"Limited credit experience"
],
[
"ninjaedge_uwcore_feature_11",
"25"
],
[
"score_general_factor_code_2",
"5"
],
[
"ninjaedge_voi_feature_27",
"0.0"
],
[
"ninjaedge_uwcore_feature_14",
"-303.19"
],
[
"ninjaedge_uwcore_feature_28",
"0"
],
[
"score_general_factor_1",
"Income insufficient for amount of credit requested"
],
[
"score_general_factor_code_4",
"6"
],
[
"ninjaedge_voiexp_feature_3",
"0"
],
[
"ninjaedge_uwcore_feature_16",
"17"
],
[
"ninjaedge_voi_feature_28",
"56"
],
[
"ninjaedge_uwcore_feature_29",
"0"
],
[
"ninjaedge_voi_feature_12",
"3"
],
[
"ninjaedge_uwcore_feature_20",
"0"
],
[
"ninjaedge_uwcore_feature_8",
"1"
],
[
"ninjaedge_voi_feature_21",
"1650.13"
],
[
"ninjaedge_voi_feature_20",
"175.0"
],
[
"ninjaedge_uwcore_feature_25",
"1.12"
],
[
"ninjaedge_loan_feature_236",
"202.12"
],
[
"ninjaedge_uwcore_feature_15",
"3"
],
[
"ninjaedge_voi_feature_17",
"False"
],
[
"ninjaedge_uwcore_feature_9",
"4"
],
[
"ninjaedge_uwcore_feature_24",
"0.0"
],
[
"ninjaedge_uwcore_feature_19",
"0"
],
[
"ninjaedge_voi_feature_26",
"0.0"
],
[
"score_general_factor_code_3",
"2"
],
[
"score_general_factor_code_0",
"0"
],
[
"ninjaedge_loan_feature_232",
"4"
],
[
"score_general_factor_4",
"Unable to verify credit references"
],
[
"ninjaedge_loan_feature_216",
"0"
],
[
"ninjaedge_voi_feature_7",
"5.03"
],
[
"ninjaedge_voiexp_feature_6",
"0.0"
],
[
"ninjaedge_loan_feature_235",
"20.6"
],
[
"ninjaedge_uwcore_feature_23",
"False"
],
[
"ninjaedge_loan_feature_238",
"78.39"
],
[
"ninjaedge_uwcore_feature_17",
"11"
],
[
"ninjaedge_voi_feature_29",
"True"
],
[
"score_general_factor_code_1",
"4"
],
[
"ninjaedge_loan_feature_200",
"0"
],
[
"ninjaedge_uwcore_feature_2",
"16"
],
[
"ninjaedge_voi_feature_6",
"902.1"
],
[
"ninjaedge_voiexp_feature_5",
"0.0"
],
[
"score_general_factor_2",
"Temporary or irregular employment"
],
[
"ninjaedge_voi_feature_16",
"False"
],
[
"ninjaedge_uwcore_feature_3",
"582"
],
[
"ninjaedge_voiexp_feature_4",
"0"
],
[
"ninjaedge_voi_feature_25",
"14.0"
],
[
"ninjaedge_voi_feature_9",
"677.86"
],
[
"score_general_factor_3",
"Unable to verify income"
],
[
"ninjaedge_voiexp_feature_9",
"identity.ibv_report_income_streams"
],
[
"ninjaedge_voi_feature_14",
"[\"2024-09-16: 150.0\", \"2024-08-19: 200.0\"]"
]
]
}Updated about 12 hours ago