TrueVault Identity Manager

Identity

The Identity API is used for most identity and credential sharing request and receipt workflows.

This API is particularly suitable for long running requests (e.g. where a background check needs to be obtained), or asynchronous requests (e.g. integrating with a 3rd party application such as Salesforce).

Identity API Request Flow

  1. Client sends POST /identity/request with seed data, purpose, and return_url

  2. API responds 200 OK with access_request_code, identity_session_code, and redirect_url

  3. Client redirects User to redirect_url

  4. User completes identity verification

  5. API sends POST webhook to Client with access_request_code and access_token (JWT String)

  6. Client responds 200 OK

  7. Client sends GET /identity/response/{access_request_code}/{identity_session_code} with X-Access-Token header

  8. API responds 200 OK with identity data

  9. User is redirected back to Client