curl --request GET \
--url https://api-sandbox.argyle.com/v2/reports/{id} \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://api-sandbox.argyle.com/v2/reports/{id}"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://api-sandbox.argyle.com/v2/reports/{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://api-sandbox.argyle.com/v2/reports/{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 => [
"Authorization: Basic <encoded-value>"
],
]);
$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://api-sandbox.argyle.com/v2/reports/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Basic <encoded-value>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api-sandbox.argyle.com/v2/reports/{id}")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.argyle.com/v2/reports/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body{
"id": "43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b",
"user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
"reference_id": "43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b",
"generated_at": "2023-03-09T16:22:06.081Z",
"created_at": "2023-03-09T16:22:06.081Z",
"type": "voie",
"status": "generated",
"file_url": "www.argyle.com/storagename/pdf",
"json_url": "www.argyle.com/storagename/json",
"last_synced_at": "2023-03-09T14:08:25.069Z",
"accounts": [
{
"id": "0187c66e-e7e5-811c-b006-2232f00f426a",
"item": "item_123456789",
"last_synced_at": "2023-03-09T14:08:25.069105Z"
},
{
"id": "0185a8b8-60eb-80ca-7482-5f24504573f7",
"item": "item_000000001",
"last_synced_at": "2023-03-01T05:10:59.558295Z"
}
],
"metadata": {},
"external_id": "July_Connection"
}Retrieve A Report
Retrieves a report object.
curl --request GET \
--url https://api-sandbox.argyle.com/v2/reports/{id} \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://api-sandbox.argyle.com/v2/reports/{id}"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://api-sandbox.argyle.com/v2/reports/{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://api-sandbox.argyle.com/v2/reports/{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 => [
"Authorization: Basic <encoded-value>"
],
]);
$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://api-sandbox.argyle.com/v2/reports/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Basic <encoded-value>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api-sandbox.argyle.com/v2/reports/{id}")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.argyle.com/v2/reports/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body{
"id": "43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b",
"user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
"reference_id": "43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b",
"generated_at": "2023-03-09T16:22:06.081Z",
"created_at": "2023-03-09T16:22:06.081Z",
"type": "voie",
"status": "generated",
"file_url": "www.argyle.com/storagename/pdf",
"json_url": "www.argyle.com/storagename/json",
"last_synced_at": "2023-03-09T14:08:25.069Z",
"accounts": [
{
"id": "0187c66e-e7e5-811c-b006-2232f00f426a",
"item": "item_123456789",
"last_synced_at": "2023-03-09T14:08:25.069105Z"
},
{
"id": "0185a8b8-60eb-80ca-7482-5f24504573f7",
"item": "item_000000001",
"last_synced_at": "2023-03-01T05:10:59.558295Z"
}
],
"metadata": {},
"external_id": "July_Connection"
}Response
Timestamp (ISO 8601) when the report was requested.
Timestamp (ISO 8601) when the report was requested.
The type of report.
voie- Verification of Income and Employmentvoe- Verification of Employmentvoie-mortgage- Verification of Income and Employment, integrated with Fannie Mae's Desktop Underwriter (DU) validation service and Freddie Mac's asset and income modeler (AIM)voe-mortgage- Verification of Employment, integrated with Fannie Mae's Desktop Underwriter (DU) validation service and Freddie Mac's asset and income modeler (AIM)
voe, voie, voe-mortgage, voie-mortgage Progress of report generation.
waiting_for_sync: Data from the connected payroll account is still being retrieved.generating: The report is being generated.generated: The report is ready to download.failed: A system error occurred, preventing report generation.
waiting_for_sync, generating, generated, failed Download link to the report PDF.
This static URL redirects to a download page that requires Argyle authentication headers. See the dropdown below for more information.
Implementation requirements for client-side applications:
Download link to the report in JSON.
This static URL redirects to a download page that requires Argyle authentication headers. See the dropdown below for more information.
Timestamp (ISO 8601) when the account used to generate the report was last scanned for new data before the report was generated. If multiple accounts were used, the more recent timestamp.
Used to populate the "Data as of" date on the report PDF.
The external_id of the user, otherwise null.