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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Argyle

Argyle Partners API

The Partners API from Argyle — 15 operation(s) for partners.

Documentation Provider Profile APIs.io OpenAPI GitHub

Argyle Partners 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 Partners. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and 1 JSON Schema.

This API exposes 17 operations across 15 paths, and defines 38 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.

17 operations 15 paths 38 schemas 8 GET2 PATCH7 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
Contact
Argyle Support
Resource Areas
1

Authentication & Security 1

Argyle Partners 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 17

Across 15 paths, the API surfaces 17 operations — 8 GET, 2 PATCH, 7 POST. Each is listed below with its method, path, parameters, and response codes.

Partners 17
POST
/partners/v2/users
Create a user
body → 200
PATCH
/partners/v2/users/{id}
Update a user
1 param body → 200
POST
/partners/v2/sessions
Create a session
body → 200
POST
/partners/v2/verifications
Order a verification
body → 200
GET
/partners/v2/verifications
List all verifications
7 params → 200
POST
/partners/v2/verifications/refresh
Refresh a verification
body → 200
GET
/partners/v2/verifications/{id}
Retrieve a verification
1 param → 200
PATCH
/partners/v2/verifications/{id}
Update a verification
1 param body → 200
POST
/partners/v2/verifications/{id}/cancel
Cancel a verification
1 param → 200
POST
/partners/v2/user-uploads
Upload a document
body → 200
GET
/partners/v2/accounts/{id}
Retrieve an account
1 param → 200
GET
/partners/v2/accounts
List all accounts
5 params → 200
GET
/partners/v2/payroll-documents/{id}
Retrieve a payroll document
1 param → 200
GET
/partners/v2/payroll-documents
List all payroll documents
7 params → 200
GET
/partners/v2/paystubs/{id}
Retrieve a paystub
1 param → 200
GET
/partners/v2/paystubs
List all paystubs
7 params → 200
POST
/partners/v2/receipts
Generate a receipt
body → 200

Schemas 38

The contract defines 38 schemas that model the data the API accepts and returns. The most detailed are PartnerPaystub (31 properties), PayrollDocument (14 properties), PartnerUser (13 properties), Account (12 properties). Each schema is shown below with its type and property counts.

PartnerSession
object
Partner connection session object.
4 properties
PartnerVerificationEmploymentRequest
PartnerVerificationEmployment
object
Employment details for the user.
4 properties
PartnerVerificationStatus
object
Verification status information.
3 properties
GrossPay
object
9 properties
PartnerOpenBanking
object
Banking-specific user metadata.
1 property
PartnerReportCustomField
object
Custom field returned in report JSON as a pass-through value.
3 properties
PartnerVerificationErrorResource
object
Verification error resource details.
3 properties
PartnerVerificationCreateRequest
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
Deduction
object
4 properties
PartnerUserUpdateRequest
object
10 properties
PartnerSessionCreateConfiguration
object
Connection session configuration for payroll and banking verifications.
7 properties
PartnerUserCreateRequest
object
11 properties 1 required
PayrollDocument
object
14 properties
PartnerUser
object
Partner user object.
13 properties
PartnerVerificationLoan
object
Optional loan details.
4 properties
Account
object
12 properties
PartnerAddress
object
Address of the user.
6 properties
PartnerCreateUserResponse
object
Response returned after creating a partner user.
2 properties
PartnerVerificationBilling
object
Optional billing details.
1 property
PartnerVerificationReportConfiguration
object
Optional banking report configurations.
5 properties
PartnerVerification
object
12 properties
PartnerSessionConfiguration
PartnerOpenBankingEndUser
object
Contains details about the person or entity making the lending decision.
6 properties
PartnerVerificationUpdateRequest
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
PartnerVerificationCreateReportRequest
object
Report request configuration.
2 properties 1 required
GrossPayTotal
object
6 properties
PartnerVerificationRefreshRequest
object
4 properties 2 required
Destination
object
5 properties
PartnerVerificationReport
object
Report information.
5 properties
PartnerPaystub
object
31 properties
PartnerVerificationError
object
Verification error details.
4 properties
Tax
object
4 properties
FilingStatus
object
3 properties
PartnerBirthDate
object
Date of birth in year-month-day format.
3 properties
PartnerVerificationRefreshReportRequest
object
Report request configuration for refresh requests.
2 properties 1 required
AvailabilityItem
object
Status of the account's most recent data scan (initial data retrieval included) or [document upload](/api-reference/user-uploads) submission. - inprogress — A…
7 properties
PartnerSessionCreateRequest
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

argyle-partners-api-openapi.yml Raw ↑

Other APIs Argyle publishes across the network.

Argyle Accounts API
AE Profile APIs.io
Argyle Deposit Destinations API
AE Profile APIs.io
Argyle Employer Search API
AE Profile APIs.io
Argyle Employments API
AE Profile APIs.io
Argyle Gigs API
AE Profile APIs.io
Argyle Identities API
AE Profile APIs.io
Argyle Invites API
AE Profile APIs.io
Argyle Item Filters API
AE Profile APIs.io
Argyle Item Migrations API
AE Profile APIs.io
Argyle Items API
AE Profile APIs.io
Argyle Open Banking API
AE Profile APIs.io
Argyle Payroll Documents API
AE Profile APIs.io
#Partners
← Back to A APIs
API Details
ID
argyle:argyle-partners-api
Base URL
https://api.argyle.com/v2
Docs
https://docs.argyle.com/api-guide/overview
Provider
Argyle
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=argyle-partners-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/argyle-partners-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Argyle Partners 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.