How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Argyle Verifications API

The Verifications API from Argyle — 4 operation(s) for verifications.

Argyle Verifications API is one of 27 APIs that Argyle publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Verification. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and 1 JSON Schema.

This API exposes 6 operations across 4 paths, and defines 16 schemas. It is described by OpenAPI 3.2.0, at version 2.0.

Requests are made against 2 base URLs: https://api.argyle.com, https://api-sandbox.argyle.com.

6 operations 4 paths 16 schemas 2 GET1 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0
Base URL
https://api.argyle.com/v2
Authentication
HTTP Basic
Resource Areas
1

Authentication & Security 1

Argyle Verifications API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • basicAuth — Username = apikeyid, Password = apikeysecret

Paths & Operations 6

Across 4 paths, the API surfaces 6 operations — 2 GET, 1 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Verifications 6
POST
/v2/verifications
Order a verification
body → 200
GET
/v2/verifications
List all verifications
7 params → 200
POST
/v2/verifications/refresh
Refresh a verification
body → 200
GET
/v2/verifications/{id}
Retrieve a verification
1 param → 200
PATCH
/v2/verifications/{id}
Update a verification
1 param body → 200
POST
/v2/verifications/{id}/cancel
Cancel a verification
1 param → 200

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are ClientVerification (11 properties), ClientVerificationCreateRequest (5 properties), ClientVerificationReportConfiguration (5 properties), ClientVerificationReport (5 properties). Each schema is shown below with its type and property counts.

ClientVerificationUpdateRequest
object
Request body for updating a verification. - loan and billing can be updated for either data source. - employments can only be updated when a document verificat…
3 properties
ClientVerificationRefreshRequest
object
4 properties 2 required
ClientVerificationStatus
object
Verification status information.
3 properties
ClientReportCustomField
object
Custom field returned in report JSON as a pass-through value.
3 properties
ClientVerificationErrorResource
object
Verification error resource details.
3 properties
ClientVerificationRefreshReportRequest
object
Report request configuration for refresh requests.
2 properties 1 required
ClientVerificationCreateRequest
object
Request body for ordering a verification. - user and report are required for all requests. - employments is required for document verifications only. - report.…
5 properties 2 required
ClientVerificationEmployment
object
Employment details for the user.
4 properties
ClientVerificationBilling
object
Optional billing details.
1 property
ClientVerificationReport
object
Report information.
5 properties
ClientVerificationReportConfiguration
object
Optional banking report configurations.
5 properties
ClientVerificationCreateReportRequest
object
Report request configuration.
2 properties 1 required
ClientVerificationEmploymentRequest
ClientVerificationLoan
object
Optional loan details.
4 properties
ClientVerificationError
object
Verification error details.
4 properties
ClientVerification
object
11 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

argyle-verifications-api-openapi.yml Raw ↑

Other APIs Argyle publishes across the network.

Argyle Accounts API
Argyle Deposit Destinations API
Argyle Employer Search API
Argyle Employments API
Argyle Gigs API
Argyle Identities API
Argyle Invites API
Argyle Item Filters API
Argyle Item Migrations API
Argyle Items API
Argyle Open Banking API
Argyle Partners API
Where this information came from

This is an independent, third-party profile of Argyle Verifications API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.