Retrieve a scoring attributes report
curl --request GET \
--url https://prod.truv.com/v1/scoring_attributes/reports/{report_id} \
--header 'X-Access-Client-Id: <api-key>' \
--header 'X-Access-Secret: <api-key>'import requests
url = "https://prod.truv.com/v1/scoring_attributes/reports/{report_id}"
headers = {
"X-Access-Client-Id": "<api-key>",
"X-Access-Secret": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'X-Access-Client-Id': '<api-key>', 'X-Access-Secret': '<api-key>'}
};
fetch('https://prod.truv.com/v1/scoring_attributes/reports/{report_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://prod.truv.com/v1/scoring_attributes/reports/{report_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Access-Client-Id: <api-key>",
"X-Access-Secret: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://prod.truv.com/v1/scoring_attributes/reports/{report_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Access-Client-Id", "<api-key>")
req.Header.Add("X-Access-Secret", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://prod.truv.com/v1/scoring_attributes/reports/{report_id}")
.header("X-Access-Client-Id", "<api-key>")
.header("X-Access-Secret", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://prod.truv.com/v1/scoring_attributes/reports/{report_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Access-Client-Id"] = '<api-key>'
request["X-Access-Secret"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"report_id": "<string>",
"guid": "<string>",
"refresh": true,
"lender_reference": "appl-1234",
"customer_identifier": "cust-9999",
"purpose": "decisioning",
"status": "success",
"cutoff_date": "2021-03-31",
"created_at": "2022-03-16 12:56:15 -0700",
"updated_at": "2022-03-16 12:56:17 -0700",
"alerts": [
{
"alert_code": 1,
"message": "No consistent income sources present"
}
],
"scores": [
{
"name": "Overdraft Risk Score",
"version": 1,
"value": 750
}
],
"metrics": [
{
"name": "derived_nsf_fee_amount",
"time_period": "2m_l0",
"short_name": "drvd_nsf_fee_amt_2m_l0",
"unit": "dollars",
"value": 23.99
}
],
"derived_incomes": [
{
"description": "direct deposit from xyz company",
"frequency": "semi_monthly",
"days": [
15,
-1
],
"formatted_frequency": "Semi-Monthly (15, eom)",
"months": 3,
"average_amount": 475.99,
"monthly_amount": 1003.21
}
]
}{
"error": {
"code": "unable_to_process",
"message": "Unable to process"
}
}{
"error": {
"code": "authentication_failed",
"message": "No such token"
}
}{
"error": {
"code": "not_authenticated",
"message": "Authentication credentials were not provided."
}
}{
"error": {
"code": "not_found",
"message": "Not found"
}
}Scoring Attributes Reports
Retrieve a scoring attributes report
GET
/
v1
/
scoring_attributes
/
reports
/
{report_id}
Retrieve a scoring attributes report
curl --request GET \
--url https://prod.truv.com/v1/scoring_attributes/reports/{report_id} \
--header 'X-Access-Client-Id: <api-key>' \
--header 'X-Access-Secret: <api-key>'import requests
url = "https://prod.truv.com/v1/scoring_attributes/reports/{report_id}"
headers = {
"X-Access-Client-Id": "<api-key>",
"X-Access-Secret": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'X-Access-Client-Id': '<api-key>', 'X-Access-Secret': '<api-key>'}
};
fetch('https://prod.truv.com/v1/scoring_attributes/reports/{report_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://prod.truv.com/v1/scoring_attributes/reports/{report_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Access-Client-Id: <api-key>",
"X-Access-Secret: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://prod.truv.com/v1/scoring_attributes/reports/{report_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Access-Client-Id", "<api-key>")
req.Header.Add("X-Access-Secret", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://prod.truv.com/v1/scoring_attributes/reports/{report_id}")
.header("X-Access-Client-Id", "<api-key>")
.header("X-Access-Secret", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://prod.truv.com/v1/scoring_attributes/reports/{report_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Access-Client-Id"] = '<api-key>'
request["X-Access-Secret"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"report_id": "<string>",
"guid": "<string>",
"refresh": true,
"lender_reference": "appl-1234",
"customer_identifier": "cust-9999",
"purpose": "decisioning",
"status": "success",
"cutoff_date": "2021-03-31",
"created_at": "2022-03-16 12:56:15 -0700",
"updated_at": "2022-03-16 12:56:17 -0700",
"alerts": [
{
"alert_code": 1,
"message": "No consistent income sources present"
}
],
"scores": [
{
"name": "Overdraft Risk Score",
"version": 1,
"value": 750
}
],
"metrics": [
{
"name": "derived_nsf_fee_amount",
"time_period": "2m_l0",
"short_name": "drvd_nsf_fee_amt_2m_l0",
"unit": "dollars",
"value": 23.99
}
],
"derived_incomes": [
{
"description": "direct deposit from xyz company",
"frequency": "semi_monthly",
"days": [
15,
-1
],
"formatted_frequency": "Semi-Monthly (15, eom)",
"months": 3,
"average_amount": 475.99,
"monthly_amount": 1003.21
}
]
}{
"error": {
"code": "unable_to_process",
"message": "Unable to process"
}
}{
"error": {
"code": "authentication_failed",
"message": "No such token"
}
}{
"error": {
"code": "not_authenticated",
"message": "Authentication credentials were not provided."
}
}{
"error": {
"code": "not_found",
"message": "Not found"
}
}Authorizations
Response
Report successful processed
This field indicates the purpose of the report. Valid values are: ‘decisioning’ for FCRA credit decisioning, ‘verification’ for non-FCRA underwriting verifications and ‘analytics’ for retroactive reports used solely for analytical purposes.
Available options:
decisioning, verification, analytics Example:
"decisioning"
This field indicates the report's processing status. Valid values are ‘success’, ‘failed’ ‘data_import_error’ and 'processing'. The first three statuses are terminal statuses. For reports with status of 'processing', you will need to make a call to the GET reports endpoint again to retrieve the report information.
Available options:
success, failed, data_import_error, processing Example:
"success"
Was this page helpful?