Example subscription
curl --request POST \
--url https://api-sandbox.argyle.com/v2/webhooks \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"events": [
"verifications.updated"
],
"name": "name-for-the-webhook-subscription",
"url": "https://webhooks.example.com/argyle/verifications-updated",
"secret": "secret-value",
"config": {
"include_resource": true
}
}
'import requests
url = "https://api-sandbox.argyle.com/v2/webhooks"
payload = {
"events": ["verifications.updated"],
"name": "name-for-the-webhook-subscription",
"url": "https://webhooks.example.com/argyle/verifications-updated",
"secret": "secret-value",
"config": { "include_resource": True }
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
events: ['verifications.updated'],
name: 'name-for-the-webhook-subscription',
url: 'https://webhooks.example.com/argyle/verifications-updated',
secret: 'secret-value',
config: {include_resource: true}
})
};
fetch('https://api-sandbox.argyle.com/v2/webhooks', 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/webhooks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'events' => [
'verifications.updated'
],
'name' => 'name-for-the-webhook-subscription',
'url' => 'https://webhooks.example.com/argyle/verifications-updated',
'secret' => 'secret-value',
'config' => [
'include_resource' => true
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-sandbox.argyle.com/v2/webhooks"
payload := strings.NewReader("{\n \"events\": [\n \"verifications.updated\"\n ],\n \"name\": \"name-for-the-webhook-subscription\",\n \"url\": \"https://webhooks.example.com/argyle/verifications-updated\",\n \"secret\": \"secret-value\",\n \"config\": {\n \"include_resource\": true\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-sandbox.argyle.com/v2/webhooks")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"events\": [\n \"verifications.updated\"\n ],\n \"name\": \"name-for-the-webhook-subscription\",\n \"url\": \"https://webhooks.example.com/argyle/verifications-updated\",\n \"secret\": \"secret-value\",\n \"config\": {\n \"include_resource\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.argyle.com/v2/webhooks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"events\": [\n \"verifications.updated\"\n ],\n \"name\": \"name-for-the-webhook-subscription\",\n \"url\": \"https://webhooks.example.com/argyle/verifications-updated\",\n \"secret\": \"secret-value\",\n \"config\": {\n \"include_resource\": true\n }\n}"
response = http.request(request)
puts response.read_body{
"event": "verifications.updated",
"name": "name-for-the-webhook-subscription",
"data": {
"user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
"verification": "43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b",
"resource": {
"id": "43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b",
"user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
"created_at": "2023-03-09T16:22:06.081Z",
"updated_at": "2023-03-09T16:22:06.081Z",
"channel": "api",
"status": {
"state": "COMPLETED",
"code": "completed",
"errors": []
},
"report": {
"id": "2a14ce6f-3aed-4c15-8ea2-92a17b6edb95",
"type": "voie",
"file_url": "www.argyle.com/storagename/pdf",
"json_url": "www.argyle.com/storagename/json"
},
"employments": [
{
"employer": "Whole Goods",
"status": "active",
"hire_date": "2015-08-28",
"termination_date": null
}
],
"data_source": "payroll"
}
}
}Verifications
Verifications.updated webhook
The verifications.updated webhook is sent each time a verification’s state transitions to PROCESSING, PAUSED, or COMPLETED.
POST
/
v2
/
webhooks
Example subscription
curl --request POST \
--url https://api-sandbox.argyle.com/v2/webhooks \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"events": [
"verifications.updated"
],
"name": "name-for-the-webhook-subscription",
"url": "https://webhooks.example.com/argyle/verifications-updated",
"secret": "secret-value",
"config": {
"include_resource": true
}
}
'import requests
url = "https://api-sandbox.argyle.com/v2/webhooks"
payload = {
"events": ["verifications.updated"],
"name": "name-for-the-webhook-subscription",
"url": "https://webhooks.example.com/argyle/verifications-updated",
"secret": "secret-value",
"config": { "include_resource": True }
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
events: ['verifications.updated'],
name: 'name-for-the-webhook-subscription',
url: 'https://webhooks.example.com/argyle/verifications-updated',
secret: 'secret-value',
config: {include_resource: true}
})
};
fetch('https://api-sandbox.argyle.com/v2/webhooks', 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/webhooks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'events' => [
'verifications.updated'
],
'name' => 'name-for-the-webhook-subscription',
'url' => 'https://webhooks.example.com/argyle/verifications-updated',
'secret' => 'secret-value',
'config' => [
'include_resource' => true
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-sandbox.argyle.com/v2/webhooks"
payload := strings.NewReader("{\n \"events\": [\n \"verifications.updated\"\n ],\n \"name\": \"name-for-the-webhook-subscription\",\n \"url\": \"https://webhooks.example.com/argyle/verifications-updated\",\n \"secret\": \"secret-value\",\n \"config\": {\n \"include_resource\": true\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-sandbox.argyle.com/v2/webhooks")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"events\": [\n \"verifications.updated\"\n ],\n \"name\": \"name-for-the-webhook-subscription\",\n \"url\": \"https://webhooks.example.com/argyle/verifications-updated\",\n \"secret\": \"secret-value\",\n \"config\": {\n \"include_resource\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.argyle.com/v2/webhooks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"events\": [\n \"verifications.updated\"\n ],\n \"name\": \"name-for-the-webhook-subscription\",\n \"url\": \"https://webhooks.example.com/argyle/verifications-updated\",\n \"secret\": \"secret-value\",\n \"config\": {\n \"include_resource\": true\n }\n}"
response = http.request(request)
puts response.read_body{
"event": "verifications.updated",
"name": "name-for-the-webhook-subscription",
"data": {
"user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
"verification": "43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b",
"resource": {
"id": "43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b",
"user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
"created_at": "2023-03-09T16:22:06.081Z",
"updated_at": "2023-03-09T16:22:06.081Z",
"channel": "api",
"status": {
"state": "COMPLETED",
"code": "completed",
"errors": []
},
"report": {
"id": "2a14ce6f-3aed-4c15-8ea2-92a17b6edb95",
"type": "voie",
"file_url": "www.argyle.com/storagename/pdf",
"json_url": "www.argyle.com/storagename/json"
},
"employments": [
{
"employer": "Whole Goods",
"status": "active",
"hire_date": "2015-08-28",
"termination_date": null
}
],
"data_source": "payroll"
}
}
}Sent when a verification has been updated.
Authorizations
Username = api_key_id, Password = api_key_secret
Body
application/json
verifications.updated
Available options:
verifications.updated Your name for the webhook subscription.
Example:
"name-for-the-webhook-subscription"
Where you want to receive webhook delivery. This can be either a backend URL that you manage, or a URL provided by a webhook management service. Argyle handles URL encoding for webhook URLs. Send the URL in its normal, unencoded form.
Example:
"https://webhooks.example.com/argyle/verifications-updated"
Optional secret used to verify webhooks.
Example:
"secret-value"
"include_resource": true will return the verification object in the response within a resource object.
Example:
{ "include_resource": true }
⌘I