The Lead Screening API enables customers to verify leads against our comprehensive consumer reports database. When a match is found, the API returns the date of the latest report, key consumer attributes associated with the stored identity, and any prior inquiries. These attributes enhance fraud detection by providing insights into the consumer’s identity history.
For consumers with a scorecard on file, customers have the flexibility to preview credit report income, displayed in $500 intervals, or to request a full credit report if detailed consumer attributes are needed. This API is designed to facilitate reliable lead verification, allowing businesses to make informed decisions with improved efficiency and accuracy.
Prerequisites
EDGE customers must have consumer PII that they are looking to pull a report for
A consumer whose report is being pulled must have a successful report with the EDGE consumer database.
All requests to the EDGE Inquiries API require an API key, which must be included as a header in each request.
Header Name: x-api-key
Type: API key authentication
More Information / Testing:
Please contact your customer success manager directly or the EDGE support team at [email protected] to get API keys for the authentication method. We could also provide testing keys for your convenience.
Endpoint 4: Performance Reporting - Record a lead purchase
Fields
Details
Endpoint
/api/v1/inquiries/lead_purchased
Summary
Record a lead purchase
Description
Records that a lender has purchased a lead.
OperationID
lead_purchased
Request Body
Fields
Details
Description
Includes client_inquiry_id, purchasing_lender_id, and optional purchase amount.
Content
application/json
Schema
$ref: '#/components/schemas/LeadPurchaseRequest'
Required
true
Responses
Code
Description
201
Lead purchase recorded successfully
400
Invalid input
422
Validation exception
Security
api_key
write: inquiries
read: inquiries
Endpoint 5: Performance Reporting - Record loan issuance
Fields
Details
Endpoint
/api/v1/inquiries/loan_issued
Summary
Record loan issuance
Description
Logs the issuance of a loan after a lead purchase.
OperationID
loan_issued
Request Body
Fields
Details
Description
Contains loan details, including client_inquiry_id, purchasing_lender_id, credit_limit, and APR.
Content
application/json
Schema
$ref: '#/components/schemas/LoanIssueRequest'
Required
true
Responses
Code
Description
201
Loan issuance recorded successfully
400
Invalid input
422
Validation exception
Security
api_key
write: inquiries
read: inquiries
Components
Money
components:
schemas:
Money:
type: object
description: Monetary amount representation
properties:
currency:
type: string
description: Currency code in ISO 4217 format (e.g., "USD" for U.S. Dollar, "EUR" for Euro)
default: "USD"
amount:
type: number
format: decimal
description: Number representing amount (e.g., "100.53" for USD).
required:
- amount
CreditReportInquiryRequest
CreditReportInquiryRequest:
type: object
properties:
client_inquiry_id:
type: string
description: Client's inquiry (lead) internal ID
identity_tin:
type: string
pattern: '^\d{3}-\d{2}-\d{4}$'
description: Identity's Social Security Number (SSN)
identity_last_name:
type: string
identity_first_name:
type: string
identity_middle_name:
type: string
identity_name_suffix:
type: string
identity_birth_date:
type: string
format: date
description: Date and time in ISO 8601 format (e.g. "2023-11-12")
email:
type: string
format: email
pattern: '^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$'
mobile_phone:
type: string
pattern: '^\+?[1-9]\d{1,14}$' # E.164 format (international format with optional +)
home_phone:
type: string
pattern: '^\+?[1-9]\d{1,14}$' # E.164 format
work_phone:
type: string
pattern: '^\+?[1-9]\d{1,14}$' # E.164 format
work_phone_ext:
type: string
pattern: '^\d{1,6}$' # Allows up to 6 digits for extension numbers
bank_routing_number:
type: integer
bank_account_number:
type: string
drivers_license:
type: string
drivers_license_state:
type: string
enum:
- AL
- AK
- AZ
- AR
- CA
- CO
- CT
- DE
- FL
- GA
- HI
- ID
- IL
- IN
- IA
- KS
- KY
- LA
- ME
- MD
- MA
- MI
- MN
- MS
- MO
- MT
- NE
- NV
- NH
- NJ
- NM
- NY
- NC
- ND
- OH
- OK
- OR
- PA
- RI
- SC
- SD
- TN
- TX
- UT
- VT
- VA
- WA
- WV
- WI
- WY
- DC
description: State abbreviation for the driver's license state
drivers_license_issued:
type: string
format: date
description: Date in ISO 8601 format (e.g. "2023-11-12")
drivers_license_expired:
type: string
format: date
description: Date in ISO 8601 format (e.g. "2023-11-12")
stated_income_min:
$ref: '#/components/schemas/Money'
stated_income_max:
$ref: '#/components/schemas/Money'
ip_address:
type: string
pattern: '^(?:\d{1,3}\.){3}\d{1,3}$|^(?:[A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4}$'
description: IP address in either IPv4 or IPv6 format
required:
- client_inquiry_id
- identity_tin
- identity_first_name
- identity_last_name
- bank_account_number
- bank_routing_number
- mobile_phone
- email
CreditReportInquiryResponse
CreditReportInquiryResponse:
type: object
properties:
client_id:
type: string
description: Echo of client_id passed into inquiry
client_inquiry_id:
type: string
description: Echo of client_inquiry_id passed into inquiry
credit_report_id:
type: string
description: ID of the credit report on file
credit_report_date:
type: string
format: date-time
description: Date of credit report creation in ISO 8601 format, including timezone (e.g. "2023-11-12T15:30:00Z")
email_identities_count:
type: integer
description: number of identities associated with the email address
phone_identities_count:
type: integer
description: number of identities associated with the phone numbers
bank_account_identities_count:
type: integer
description: number of identities associated with the bank account
govID_identities_count:
type: integer
description: number of identities associated with provided government ID
identity_emails_count:
type: integer
description: number of emails associated with the provided identity
identity_phones_count:
type: integer
description: number of phones associated with the provided identity
identity_bank_accounts_count:
type: integer
description: number of bank accounts associated with the provided identity
identity_govIDs_count:
type: integer
description: number of government IDs associated with the provided identity
CreditReportPreviewResponse
CreditReportPreviewResponse:
type: object
properties:
client_id:
type: string
credit_report_id:
type: string
credit_report_date:
type: string
format: date-time
description: Date and time in ISO 8601 format, including timezone (e.g. "2023-11-12T15:30:00Z")
monthly_income_min:
type: integer
monthly_income_max:
type: integer
payroll_providers:
type: array
items:
description: List of payroll providers associated with the consumer, detailing payroll sources or recent payroll transactions.
type: string
minItems: 0
bank_routing_number:
type: integer
description: Routing number of bank account used to produce credit report
bank_account_number_last_4:
type: string
description: Last 4 digits of bank account used to produce credit report
CreditReportAttributesResponse
CreditReportAttributesResponse:
type: object
properties:
client_id:
type: string
description: Unique client ID identifying the user within Edge Inquiry Service
credit_report_id:
type: string
description: Identifier of the credit report, may differ if data was refreshed
credit_report_date:
type: string
format: date-time
description: Date and time of credit report issuance in ISO 8601 format, including timezone (e.g. "2023-11-12T15:30:00Z")
attribute_values:
type: array
items:
type: object
title: CreditReportAttribute
properties:
key:
type: string
description: Credit report attribute key
value:
type: string
description: Credit report attribute value
description: Array of key-value pairs containing requested credit report attributes as strings, such as `credit_score`, `total_accounts`, `debt_to_income_ratio`, and other relevant details
LeadPurchaseRequest
LeadPurchaseRequest:
type: object
properties:
client_inquiry_id:
type: string
description: Client's inquiry (lead) internal id
purchasing_lender_id:
type: string
description: Unique ID of the lender purchasing the lead
amount:
$ref: '#/components/schemas/Money'
required:
- client_inquiry_id
- purchasing_lender_id
LoanIssueRequest
LoanIssueRequest:
type: object
properties:
client_inquiry_id:
type: string
description: ID of the inquiry associated with the lead
purchasing_lender_id:
type: string
description: ID of the lender issuing the loan
purchasing_lender_loan_id:
type: string
description: Unique loan ID assigned by the lender
credit_limit:
$ref: '#/components/schemas/Money'
apr:
type: number
format: float
description: Annual Percentage Rate (APR) of the loan
payment_frequency:
type: string
description: Frequency of loan payments
enum:
- weekly
- biweekly
- semimonthly
- monthly
payment_amount:
$ref: '#/components/schemas/Money'
total_payments:
type: integer
description: Total number of payments required to repay the loan
required:
- client_inquiry_id
- purchasing_lender_id
- purchasing_lender_loan_id
- apr
- credit_limit
