curl --request POST \
--url https://api-sandbox.argyle.com/v2/sessions \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"verification": "43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b",
"configuration": {
"redirect_url": "https://your-application.com/return",
"flow_id": "12ABCD3E",
"items": [
"item_000000001",
"item_000000002"
],
"language": "EN",
"mobile_app": true
}
}
'{
"verification": "43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b",
"configuration": {
"experience": null,
"single_use_url": false,
"redirect_url": "https://your-application.com/return",
"flow_id": "12ABCD3E",
"items": [
"item_000000001",
"item_000000002"
],
"language": "EN",
"mobile_app": true
},
"link": "https://connect.argyle.com/?...",
"data_source": "payroll"
}Verifications
Create a session
Create a connection session, send an invite, or create an invite link.
POST
/
v2
/
sessions
curl --request POST \
--url https://api-sandbox.argyle.com/v2/sessions \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"verification": "43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b",
"configuration": {
"redirect_url": "https://your-application.com/return",
"flow_id": "12ABCD3E",
"items": [
"item_000000001",
"item_000000002"
],
"language": "EN",
"mobile_app": true
}
}
'{
"verification": "43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b",
"configuration": {
"experience": null,
"single_use_url": false,
"redirect_url": "https://your-application.com/return",
"flow_id": "12ABCD3E",
"items": [
"item_000000001",
"item_000000002"
],
"language": "EN",
"mobile_app": true
},
"link": "https://connect.argyle.com/?...",
"data_source": "payroll"
}-
For an embedded session, provide
verification. The response returns alinkto launch or embed the frontend experience. Thelinkexpires after one hour. -
For an invite, first create the user and at least one active verification. Set
typetoinviteand provideuser. Includeconfiguration.email,configuration.phone_number, or both to send the invite by email or SMS. Omit both to create a link you can share yourself. The invite link expires after 180 days or when revoked.
This endpoint is for payroll and banking verifications only.
Body
application/json
- Embedded
- Invites
Response
200 - application/json
- Embedded
- Invites
URL used to launch the payroll or banking frontend experience. For payroll, use it as connectUrl when initializing the Web SDK; the returned session URL already determines whether the session runs in Sandbox or Production. Alternatively, open it directly for Hosted Link. For banking, pass this value to the banking SDK as connectURL. Hosted or no-SDK banking flows must be enabled by Argyle before use. Session links expire after one hour. A new session link can be created at any time by creating another session for the active verification.