API enhancements
A new user uploads endpoint has been added to Argyle's API.
- Retrieve and filter documents that users have manually uploaded through Link.
- Retrieve Ocrolus OCR and authenticity data for manually uploaded documents.
Most relevant updates and all breaking changes.
A new user uploads endpoint has been added to Argyle's API.
The /v2/webhooks
endpoint now returns an additional property: last_sent_at
.
The last_sent_at
property provides the most recent timestamp a particular webhook was sent, and is intended to aid in webhook management and testing.
The payload of our users.fully_synced webhook now includes two additional properties:
accounts_connected
external_id
Authenticity information for uploaded documents is now available via the API when Ocrolus document processing is enabled.
The following properties have been added to the users forms endpoint:
ocr_authenticity_score
— Single integer score that captures the likelihood an uploaded document is authentic, as determined by Ocrolus.ocr_authenticity
— Object containing details on individual instances of tampering or other authenticity-related edits.The following webhook is now available:
user_forms.ocr_authenticity
— Sent when authenticity information is available for an uploaded document.Ocrolus OCR and authenticity for uploaded documents can be purchased through Argyle directly. For purchasing and setup assistance, please reach out to our customer success team.
On April 8, 2024 the file_url
field returned by the /v2/reports
endpoint will begin redirecting to a PDF download page that requires Argyle basic authentication headers.
Please ensure your HTTP client or library is configured to pursue redirects and append authentication headers to these requests to continue successfully retrieving report PDFs via the API following this adjustment.
The /item-notifications
endpoint has been deprecated. Please use the /items
endpoint going forward to retrieve information on:
status
or related messaging when connection issues occur.A new field has been added to the identities endpoint:
original_hire_date
— Timestamp of the user's earliest employment start date.The following additional fields are now returned when retrieving the JSON of Argyle verification reports via the API:
type
report_id
user_id
external_id
generated_at
last_synced_at
end_date
last_paystub_date
On January 3, 2024, we will be consolidating the list of possible type
values for gross_pay_list
objects, which are returned by the paystubs endpoint.
The following type
values will continue to be returned:
base
, pto
, bonus
, commission
, overtime
, disability
, tips
, stock
, other
The following type
value will be renamed:
insurance
will be renamed to benefits
The following type
values will be removed:
retirement
(merged with benefits
)premium
(merged with overtime
)unpaid
(merged with other
)reimbursement
(merged with other
)retro
(merged with other
)We have introduced daily
as a new possible value for period
within the base_pay
object, which is returned by the identities endpoint (API v2) and employments endpoint (API v1).