curl --request GET \
--url https://api-sandbox.argyle.com/v2/invites/{id} \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://api-sandbox.argyle.com/v2/invites/{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/invites/{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/invites/{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/invites/{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/invites/{id}")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.argyle.com/v2/invites/{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": "0424137bc-edc5-35de-c1b5-1c3cddb4b227",
"user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
"user_token": "bcJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjbGllbnRfaWEiOiIxNDRhMTRkNS04YzEzLTQzZGYtOTI4Ni01OWY4NjFkOWEyMDIiLCJleHAiOjE2ODc3OTMzODAsImZpZCI6IjUyYWM3ZFFiLTI1MzAtNGYyNy04NTZlLTkwOTk1ZDA4NWJkMCIsImlhdCI6MTY4Nzc4OTc4MCwiaXNzIjoiYXJneWxlLWNvcmUtYXV1aC1kZXYiLCJqdGkiOiI2ZWJiOGIxMS0wYzFjLTRiNjEtYmI5NS04ZGQ0YzA0OGQwNzUiLCJzdWIiOiIwMTg4ZjgxYy0zZTFkLTRlZDEtMjEyYy02NmE3YzE4YzVjYzMiLCJ1c2VyX2lkIjoiMDE4OGY4MWMtM2UxZC00ZWQxLTIxMmMtNjZhN2MxN2M1Y2MzIn0.TNiZojOiiXtPVamyCDjz4f2GwR4TA8x6JR3RwjTECjY",
"email": "sarah@email.com",
"phone_number": "212-555-5555",
"full_name": "Sarah Longfield",
"first_name": "Sarah",
"last_name": "Longfield",
"revoked_at": null,
"status": "sent",
"group_id": "d8a07e5b-13a3-11ef-af7e-c7eb00762562",
"url": "https://verify.argyle.com/connect/0424137bc-edc5-35de-c1b5-1c3cddb4b227",
"created_at": "2023-03-09T23:57:05.756Z",
"updated_at": "2023-03-09T23:57:05.756Z",
"invited_at": "2023-03-09T23:57:05.756Z",
"flow_id": "8DRRA4XC",
"flow_items": [
"item_000000001",
"item_000000002"
],
"reply_to": [
"person1@email.com",
"person2@email.com"
],
"deliveries": [
{
"id": "d7c85e44-9729-11f0-b297-f3718e19503e",
"method": "email",
"status": "sent",
"sent_at": "2023-03-09T23:57:24.000Z",
"updated_at": "2023-03-09T03:24:58.000Z"
}
],
"invite_template_id": null
}Retrieve An Invite
Retrieves an invite object.
curl --request GET \
--url https://api-sandbox.argyle.com/v2/invites/{id} \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://api-sandbox.argyle.com/v2/invites/{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/invites/{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/invites/{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/invites/{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/invites/{id}")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.argyle.com/v2/invites/{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": "0424137bc-edc5-35de-c1b5-1c3cddb4b227",
"user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
"user_token": "bcJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjbGllbnRfaWEiOiIxNDRhMTRkNS04YzEzLTQzZGYtOTI4Ni01OWY4NjFkOWEyMDIiLCJleHAiOjE2ODc3OTMzODAsImZpZCI6IjUyYWM3ZFFiLTI1MzAtNGYyNy04NTZlLTkwOTk1ZDA4NWJkMCIsImlhdCI6MTY4Nzc4OTc4MCwiaXNzIjoiYXJneWxlLWNvcmUtYXV1aC1kZXYiLCJqdGkiOiI2ZWJiOGIxMS0wYzFjLTRiNjEtYmI5NS04ZGQ0YzA0OGQwNzUiLCJzdWIiOiIwMTg4ZjgxYy0zZTFkLTRlZDEtMjEyYy02NmE3YzE4YzVjYzMiLCJ1c2VyX2lkIjoiMDE4OGY4MWMtM2UxZC00ZWQxLTIxMmMtNjZhN2MxN2M1Y2MzIn0.TNiZojOiiXtPVamyCDjz4f2GwR4TA8x6JR3RwjTECjY",
"email": "sarah@email.com",
"phone_number": "212-555-5555",
"full_name": "Sarah Longfield",
"first_name": "Sarah",
"last_name": "Longfield",
"revoked_at": null,
"status": "sent",
"group_id": "d8a07e5b-13a3-11ef-af7e-c7eb00762562",
"url": "https://verify.argyle.com/connect/0424137bc-edc5-35de-c1b5-1c3cddb4b227",
"created_at": "2023-03-09T23:57:05.756Z",
"updated_at": "2023-03-09T23:57:05.756Z",
"invited_at": "2023-03-09T23:57:05.756Z",
"flow_id": "8DRRA4XC",
"flow_items": [
"item_000000001",
"item_000000002"
],
"reply_to": [
"person1@email.com",
"person2@email.com"
],
"deliveries": [
{
"id": "d7c85e44-9729-11f0-b297-f3718e19503e",
"method": "email",
"status": "sent",
"sent_at": "2023-03-09T23:57:24.000Z",
"updated_at": "2023-03-09T03:24:58.000Z"
}
],
"invite_template_id": null
}Response
User token required to initialize embedded instances of Link for the user.
Warning: This user token will expire after one hour. A new user token can be created at any time using the /user-tokens API endpoint.
"bcJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjbGllbnRfaWEiOiIxNDRhMTRkNS04YzEzLTQzZGYtOTI4Ni01OWY4NjFkOWEyMDIiLCJleHAiOjE2ODc3OTMzODAsImZpZCI6IjUyYWM3ZFFiLTI1MzAtNGYyNy04NTZlLTkwOTk1ZDA4NWJkMCIsImlhdCI6MTY4Nzc4OTc4MCwiaXNzIjoiYXJneWxlLWNvcmUtYXV1aC1kZXYiLCJqdGki2eJiZGI4YTExMS0wYzFjLTRiNjEtYmI5NS04ZGQ0YzA0OGQwNzUiLCJzdWIiOiIwMTg4ZjgxYy0zZTFkLTRlZDEtMjEyYy02NmB3YzE4YzVjYzMiLCJ1c2VyX2lkIjoiMDE4OGY4MWMtM2UxZC00ZWQxLTIxMmMtNjZhN2MxN2M1Y2MzIn0.TNiZojOiiXtPVamyCDjz4f2GwR4TA8x6JR3RwjTECjY"
Timestamp (ISO 8601) when the invite was revoked.
null
The invite's status.
sent— Invite sent successfully.initiated— User clicked the invite URL and was successfully able to enter Link, but has not submitted login credentials, uploaded documents, or completed a response form.attempted— User submitted login credentials through Link (creating a user ID), but no accounts were successfully connected. Also includes users who only submitted a response form.completed— User successfully connected an account or uploaded a document.revoked— The invite was revoked. The user can no longer access Link via the invite URL.
sent, initiated, attempted, completed, revoked ID of the group associated with the invite.
"d8a07e5b-13a3-11ef-af7e-c7eb00762562"
Timestamp (ISO 8601) when the invite was created.
"2023-03-09T23:57:05.756Z"
Timestamp (ISO 8601) when the invite was updated.
Warning: The timestamp is updated after re-sending or revoking an invite.
"2023-03-09T23:57:05.756Z"
Timestamp (ISO 8601) when the invite was sent. Warning: The timestamp is updated after re-sending or revoking an invite.
"2023-03-09T23:57:05.756Z"
Emails of your team members that will be notified when the user has connected their payroll account(s).
Depending on the invite method, these emails are sourced from:
- If sending invites via the API, the
reply_toparameter of theoverride_invite_templateobject. - If sending invites via Console, the Console member that sends the invite and any Cc'd members of your team.
- If sending invites via Argyle's POS & LOS integrations (Encompass, Empower, or nCino), the email address of the Loan Officer sending the invite.
- If sending links to Argyle using Shareable URLs, any emails saved in the email notifications toggle of "General settings" of the associated Shareable URL Flow.
- If sending links to Argyle using Shareable URLs with URL modifications, the email overwrite specified at the end of the URL.
(Deprecated) Customization ID.
- Deprecated in favor of
override_invite_template.
null