curl --request GET \
--url https://api-sandbox.argyle.com/v2/payroll-documents/{id} \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://api-sandbox.argyle.com/v2/payroll-documents/{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/payroll-documents/{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/payroll-documents/{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/payroll-documents/{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/payroll-documents/{id}")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.argyle.com/v2/payroll-documents/{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": "0183b2c1-02e5-a5e5-38f2-ecd51a5cf3d6",
"account": "0187c66e-e7e5-811c-b006-2232f00f426a",
"document_number": "ced46eb3-7586-3cd7-2418-8eb9482bc3ec",
"available_date": "2019-03-14T17:46:25Z",
"expiration_date": "2027-03-12T17:46:25Z",
"employer": "GigAndGo",
"employment": "42d6531c-520a-26b9-35c3-b7137a6d205a",
"document_type": "drivers-licence",
"document_type_description": "Driver's license",
"file_url": "api.argyle.com/v2/payroll-documents/{id}/file",
"created_at": "2023-03-13T17:46:28.240Z",
"updated_at": "2023-03-13T17:46:28.240Z",
"ocr_data": {},
"metadata": {}
}Retrieve A Payroll Document
Retrieves a payroll document object.
curl --request GET \
--url https://api-sandbox.argyle.com/v2/payroll-documents/{id} \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://api-sandbox.argyle.com/v2/payroll-documents/{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/payroll-documents/{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/payroll-documents/{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/payroll-documents/{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/payroll-documents/{id}")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.argyle.com/v2/payroll-documents/{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": "0183b2c1-02e5-a5e5-38f2-ecd51a5cf3d6",
"account": "0187c66e-e7e5-811c-b006-2232f00f426a",
"document_number": "ced46eb3-7586-3cd7-2418-8eb9482bc3ec",
"available_date": "2019-03-14T17:46:25Z",
"expiration_date": "2027-03-12T17:46:25Z",
"employer": "GigAndGo",
"employment": "42d6531c-520a-26b9-35c3-b7137a6d205a",
"document_type": "drivers-licence",
"document_type_description": "Driver's license",
"file_url": "api.argyle.com/v2/payroll-documents/{id}/file",
"created_at": "2023-03-13T17:46:28.240Z",
"updated_at": "2023-03-13T17:46:28.240Z",
"ocr_data": {},
"metadata": {}
}Response
Unique ID of the payroll document object.
Also the payroll_document ID value of the paystub object.
Timestamp (ISO 8601) when the payroll document was made available to the user on the underlying payroll system.
Timestamp (ISO 8601) when payroll document (such as a driver's license) expires.
Employment ID. Can be used as a filter when listing payroll documents.
The type of payroll document, as returned by the payroll system. The following values are the most common, but document_type is not restricted to these values.
payout-statement, W-2, W-4, W-9, 1095, 1095-C, 1099, profile-picture, drivers-license, vehicle-insurance, vehicle-registration, vehicle-inspection, other URL linking to the original payroll document file.
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
-
Ensure your HTTP client or library (e.g. Axios, Python requests, etc.) or similar tool is configured to pursue redirects. Most tools support this functionality.
-
Basic authentication headers for Argyle must be appended to the file download request.
Timestamp (ISO 8601) when the payroll document object was created.
Timestamp (ISO 8601) when a property value of the payroll document object most recently changed.