Equifax Session — Start Credit Report Flow
Start an Equifax credit report session with a consent-based redirect. Returns a URL where the user authorizes their credit data pull.
curl -X POST "https://production.deepvue.tech/v3/financial-services/credit-bureau/equifax/credit-report/sdk/session" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN (JWT)" \
-H "x-api-key: YOUR_API_KEY" \
-d '{
"redirect_uri": "example_string",
"mobile_number": "example_string",
"full_name": "John Doe",
"version": "example_string",
"enrich": true
}'
import requests
import json
url = "https://production.deepvue.tech/v3/financial-services/credit-bureau/equifax/credit-report/sdk/session"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN (JWT)",
"x-api-key": "YOUR_API_KEY"
}
data = {
"redirect_uri": "example_string",
"mobile_number": "example_string",
"full_name": "John Doe",
"version": "example_string",
"enrich": true
}
response = requests.post(url, headers=headers, json=data)
print(response.json())
const response = await fetch("https://production.deepvue.tech/v3/financial-services/credit-bureau/equifax/credit-report/sdk/session", {
method: "POST",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN (JWT)",
"x-api-key": "YOUR_API_KEY"
},
body: JSON.stringify({
"redirect_uri": "example_string",
"mobile_number": "example_string",
"full_name": "John Doe",
"version": "example_string",
"enrich": true
})
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
"bytes"
"encoding/json"
)
func main() {
data := []byte(`{
"redirect_uri": "example_string",
"mobile_number": "example_string",
"full_name": "John Doe",
"version": "example_string",
"enrich": true
}`)
req, err := http.NewRequest("POST", "https://production.deepvue.tech/v3/financial-services/credit-bureau/equifax/credit-report/sdk/session", bytes.NewBuffer(data))
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN (JWT)")
req.Header.Set("x-api-key", "YOUR_API_KEY")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://production.deepvue.tech/v3/financial-services/credit-bureau/equifax/credit-report/sdk/session')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN (JWT)'
request['x-api-key'] = 'YOUR_API_KEY'
request.body = '{
"redirect_uri": "example_string",
"mobile_number": "example_string",
"full_name": "John Doe",
"version": "example_string",
"enrich": true
}'
response = http.request(request)
puts response.body
{
"code": 201,
"timestamp": 1751922499674,
"transaction_id": "a73af0b7accc4c3fbaa3dd2dc2cab550",
"sub_code": "SUCCESS",
"message": "SDK session created successfully.",
"data": {
"redirect_url": "https://sdk.deepvue.ai/v1/credit-report/equifax?session_id=bee5325d10124a18a322ca268542aa06&signature=ddfc046359adca4e8d31cbce13597b1307f7c61923da3b4ee78f60e6f9524123&redirect_uri=https://deepvue.tech"
}
}
{
"detail": "Inactive client_id"
}
{
"detail": "Not authenticated"
}
{
"detail": "Not a valid token"
}
{
"detail": [
{
"loc": [
"body",
"consent"
],
"msg": "field required",
"type": "value_error.missing"
}
]
}
{
"detail": "Internal Server Error"
}
/v3/financial-services/credit-bureau/equifax/credit-report/sdk/session
ACCESS_TOKEN generated from the authorize endpoint. Should be included in the header as Bearer .
The CLIENT_SECRET provided to you. This header parameter is required for authentication purposes.
The media type of the request body
This is the URL to your own application where you want the end user to be finally redirected once the consent is given.
Pass Mobile Number if you wish this to be pre-filled in the UI form
Pass user's Full Name as per PAN if you wish this to be pre-filled in the UI form
Pass version=v3 to fetch the credit report as per the latest version during download
Pass enrich=true if you wish to generate a report even when there is no existing credit history.
Request Preview
Response
Response will appear here after sending the request
Authentication
Bearer token (JWT). ACCESS_TOKEN generated from the authorize endpoint. Should be included in the header as Bearer .
API Key for authentication. The CLIENT_SECRET provided to you. This header parameter is required for authentication purposes.
Body
This is the URL to your own application where you want the end user to be finally redirected once the consent is given.
Pass Mobile Number if you wish this to be pre-filled in the UI form
Pass user's Full Name as per PAN if you wish this to be pre-filled in the UI form
Pass version=v3 to fetch the credit report as per the latest version during download
Pass enrich=true if you wish to generate a report even when there is no existing credit history.
Responses
Overview
This API initiates a session and generates a transaction_id which is used in the subsequent API flow. It serves as a server-to-server mechanism allowing you to authenticate and launch an SDK session.
Upon successful authentication, the system returns a secure, signed URL for redirecting end-users to the credit report interface. The platform validates your credentials and generates a secure redirect URL containing session parameters. This URL directs users to complete their credit report verification workflow through the Deepvue SDK interface before being redirected back to your specified application.
The endpoint accepts optional fields for pre-populating user information, including mobile number and full name (as per PAN documentation). Additional parameters allow specification of report version and enrichment options for cases lacking existing credit history.
You need an authorized access token to access any of the Platform APIs. One access token is valid for only 24 hours. After expiration, you can renew the token by using the Authorize endpoint to receive a fresh access token.
Last updated 4 weeks ago
Built with Documentation.AI