Using EDGE Screen
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 | [email protected] | 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": "edge",
"client_inquiry_id": "abc123",
"credit_report_id": "IBVE503E3BB84F085314CA7",
"credit_report_age_in_days": 14,
"credit_report_date": "2025-11-19T03:07:12Z",
"email_identities_count": 1,
"phone_identities_count": 1,
"bank_account_identities_count": 1,
"govID_identities_count": 0,
"identity_emails_count": 1,
"identity_phones_count": 1,
"identity_bank_accounts_count": 1,
"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}
Note: without adding the target_bank_account_suffix query parameter to the of the URL, you may be pulling a credit report for multiple accounts, depending on the connection the consumer previously made. If the desired outcome is to make a request for a report of a specific consumer account, please append the last 4 digits of the consumers bank account as an additional URL path parameter in your GET request: https://api.edgescore.com/api/v1/inquiries/preview/{credit_report_id}?{target_bank_account_suffix}
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 |
| target_bank_account_suffix | Last 4 digits of the bank account number used to specify the target bank account for the inquiry | 8915 | No |
Example
{
"client_id": "edge",
"credit_report_id": "IBVE503E3BB84F085314CA7",
"payroll_providers": [
"DEPOSIT\nCHARTER OF WAYNE CHARTER OF WAYNE DEPOSIT"
],
"credit_report_date": "2025-11-19T03:07:12Z",
"monthly_income_max": 3500,
"monthly_income_min": 3000,
"bank_routing_number": 31101279,
"bank_account_number_last_4": "5556"
}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/report/{credit_report_id}
Note: without adding thetarget_bank_account_suffix query parameter to the of the URL, you may be pulling a credit report for multiple accounts, depending on the connection the consumer previously made. If the desired outcome is to make a request for a report of a specific consumer account, please append the last 4 digits of the consumers bank account as an additional URL path parameter in your GET request: https://api.edgescore.com/api/v1/inquiries/report/{credit_report_id}?{target_bank_account_suffix}
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": "edge",
"credit_report_id": "IBVE503E3BB84F085314CA7",
"credit_report_date": "2025-11-19T03:07:12Z",
"attribute_values": [
[
"ninjaedge_uwcore_feature_38",
"identity.ibv_report_loan_payments"
],
[
"score_general",
"664.0"
],
[
"ninjaedge_voi_feature_15",
"False"
],
[
"ninjaedge_voi_feature_18",
"False"
],
[
"ninjaedge_voi_feature_23",
"-0.688"
],
[
"ninjaedge_voi_feature_11",
"1"
],
[
"ninjaedge_voi_feature_22",
"24"
],
[
"ninjaedge_loan_feature_237",
"0.0"
],
[
"ninjaedge_voi_feature_19",
"False"
],
[
"ninjaedge_loan_feature_233",
"42.1"
],
[
"ninjaedge_uwcore_feature_12",
"363"
],
[
"ninjaedge_voi_feature_13",
"2.12"
],
[
"ninjaedge_loan_feature_205",
"0.0"
],
[
"ninjaedge_loan_feature_222",
"42.1"
],
[
"ninjaedge_loan_feature_219",
"42.1"
],
[
"ninjaedge_loan_feature_217",
"42.1"
],
[
"ninjaedge_voi_feature_8",
"1156.1"
],
[
"ninjaedge_voi_feature_5",
"399.46"
],
[
"ninjaedge_uwcore_feature_26",
"14.0"
],
[
"ninjaedge_uwcore_feature_10",
"1"
],
[
"ninjaedge_voi_feature_10",
"812.29"
],
[
"ninjaedge_voi_feature_24",
"FMOLHS DIR DEP PPD\n"
],
[
"ninjaedge_uwcore_feature_1",
"55"
],
[
"bank_routing_number",
""
],
[
"score_general_factor_0",
"Number and / or amount of debt payments"
],
[
"ninjaedge_uwcore_feature_11",
"89"
],
[
"ninjaedge_loan_feature_203",
"42.1"
],
[
"ninjaedge_voi_feature_27",
"0.616"
],
[
"score_general_factor_code_2",
"0"
],
[
"ninjaedge_uwcore_feature_28",
"0"
],
[
"score_general_factor_1",
"Number of debt deposits"
],
[
"score_general_factor_code_4",
"10"
],
[
"ninjaedge_uwcore_feature_29",
"0"
],
[
"ninjaedge_voi_feature_28",
"13"
],
[
"ninjaedge_uwcore_feature_16",
"0"
],
[
"ninjaedge_voi_feature_12",
"1"
],
[
"ninjaedge_uwcore_feature_20",
"0"
],
[
"ninjaedge_uwcore_feature_8",
"0"
],
[
"ninjaedge_voi_feature_21",
"1084.745"
],
[
"bank_account_suffix",
"8363"
],
[
"ninjaedge_voi_feature_20",
"1090.042"
],
[
"ninjaedge_loan_feature_236",
"42.1"
],
[
"ninjaedge_uwcore_feature_15",
"0"
],
[
"ninjaedge_uwcore_feature_24",
"812.29"
],
[
"ninjaedge_uwcore_feature_9",
"1"
],
[
"ninjaedge_voi_feature_17",
"False"
],
[
"ninjaedge_loan_feature_220",
"42.1"
],
[
"ninjaedge_uwcore_feature_19",
"0"
],
[
"ninjaedge_voi_feature_26",
"712.5"
],
[
"ninjaedge_loan_feature_201",
"42.1"
],
[
"ninjaedge_uwcore_feature_25",
"-1.065"
],
[
"score_general_factor_code_3",
"15"
],
[
"score_general_factor_code_0",
"5"
],
[
"ninjaedge_loan_feature_232",
"1"
],
[
"score_general_factor_4",
"Amount of pay and deposit events"
],
[
"ninjaedge_loan_feature_216",
"1"
],
[
"ninjaedge_voi_feature_7",
"0.04"
],
[
"ninjaedge_loan_feature_235",
"42.1"
],
[
"ninjaedge_uwcore_feature_23",
"False"
],
[
"ninjaedge_loan_feature_238",
"42.1"
],
[
"ninjaedge_loan_feature_206",
"42.1"
],
[
"ninjaedge_voi_feature_29",
"False"
],
[
"score_general_factor_code_1",
"7"
],
[
"ninjaedge_loan_feature_221",
"0.0"
],
[
"ninjaedge_loan_feature_200",
"1"
],
[
"ninjaedge_uwcore_feature_2",
"175"
],
[
"ninjaedge_voi_feature_6",
"700.15"
],
[
"score_general_factor_2",
"History of negative or low balances"
],
[
"ninjaedge_voi_feature_16",
"False"
],
[
"ninjaedge_uwcore_feature_3",
"500"
],
[
"ninjaedge_loan_feature_204",
"42.1"
],
[
"ninjaedge_voi_feature_25",
"14.608"
],
[
"ninjaedge_voi_feature_9",
"1112.56"
],
[
"score_general_factor_3",
"Bank account utilization"
],
[
"ninjaedge_voi_feature_14",
"[\"2025-07-16: 1142.32\", \"2025-07-02: 995.18\", \"2025-06-18: 1111.64\", \"2025-06-04: 1083.42\", \"2025-05-21: 1065.86\", \"2025-05-07: 1104.12\", \"2025-04-23: 1127.76\"]"
]
]
}Updated 9 months ago
Did this page help you?