The IBV REST APIs are specifically crafted to facilitate server-to-server communication. Clients can make a POST request to https://api.edgescore.com/api/v2/ibv/requests to request a report.

To gain access to this endpoint, API calls must incorporate an API key within the header. Upon onboarding, EDGE will furnish distinct API keys for each access level, ensuring stringent access control and bolstering security measures.

Request Details

Header

Body

Example

{
  "consumer_id": "CN32892349",
  "context_id": 'abc12345',
  "context_data": 'application123',
  "ssn": "322-32-5345",
  "first_name": "John",
  "middle_name": "Edge",
  "last_name": "Smith",
  "birth_date": "1776-07-04",
  "full_address": "full address",
  "street_address": "222 South Riverside Plaza",
  "street_address2": "Suite 200",
  "city": "Chicago",
  "state_code": "IL",
  "zip_code": "60606",
  "home_phone": "855-646-5201",
  "mobile_phone": "855-646-5201",
  "email": "[email protected]",
  "secondary_email": "[email protected]",
  "employer_name": "EDGE",
  "secondary_employer_name": "EDGE2",
  "bank_name": "Bank of America",
  "routing_number": "0740000101",
  "account_number": "2302389238923",
  "debit_card_number": "1234567890123456",
  "additional_data": {
    "vantage_score": 500,
    "housing": "rent",
    "existing_customer": true
  },
  "reference_date": "2023-08-01",
  "partner_name": "<only applies to partners>"
}

Responses

👍

IBV Report - HTTP 200

The Client will usually receive the IBV Report when a request with IBV data has been successfully received. A request without IBV data may also receive the IBV report immediately if the consumer has an active IBV connection on the platform.

📘

Processing Request - HTTP 202

The Client will receive this response when a request has been successfully received, but there is a delay in generating the IBV Report. In this case, the Client should try to retrieve the report using a GET method at a later time. It is recommended to include a delay for at least 5 seconds before attempting the Get method. An alternative method is to use Webhooks. The EDGE Connect platform can initiate a Webhooks call when report generation is complete. The Client should check whether the report has already been downloaded upon receiving the Webhooks call and only download the report when necessary.

Please do not repost the same payload when receiving a 202 response. A duplicate request will be created for the same consumer.

See Retrieve IBV Report for details about retrieving the report at a later time.
The 202 response will contain a reference URL to retrieve the IBV Report when it is available. Format of the URL is: https://api.edgescore.com/api/v2/ibv/requests/{product_request_id}

The response will also contain a URL for the Consumer to link their bank account if it is a new Consumer or an existing Consumer whose IBV connection is no longer valid. The Client needs to send this link to the Consumer to establish a new connection to their bank accounts.

{
 "ibv_report": "https://api.edgescore.com/api/v2/ibv/requests/IBV23328923489",
 "product_request_id": "IBV23328923489”,
 "ibv_report_status": "initiated”,
 "ibv_connection_link": "https://c2.edgescore.com/9a3db0b97e",
 "connection_request_id": "dd94c6f7-1f67-4833-839a-c8b985f0f0ae"
}

❗️

Invalid Data - HTTP 400

The API will return a payload with information about invalid field values.

{
    "message": "Invalid data",
    "fields": {
        "ssn": [
            "SSN must be 9 digits long"
        ]
    }
}