Step 1 - Create Job to Retrieve Identity

Overview

If you are retrieving identity information for the first time, or if you want to ensure that you have the most up-to-date information from the financial institution, you will need to create an identity job.

Create Identity Job

HTTP Request

Sandbox - POST https://api.sandbox.aerosync.com/v2/accounts/{{connectionId}}/identity

Production - POST https://api.aerosync.com/v2/accounts/{{connectionId}}/identity

Path Parameters

ParameterRequired?TypeDescription
connectionIdYesStringAerosync-specific connectionId received from the SDK onSuccess

Request and Response

POST https://api.sandbox.aerosync.com/v2/accounts/{{connectionId}}/identity
Authorization: Bearer {{token}}

{
    "status": "success",
    "statusCode": 200,
    "identityStatus": "Initiated",
    "jobId": "IDT-ff1d12fc6dfa4b34ac9df85e676c30c0",
    "userId": "8cf406e45b2442e2b1ef491a5ce4cd0d",
    "connectionId": "8cf406e45b2442e2b1ef491a5ce4cd0d"
}