API for managing longer running or asynchronous TrueIdentity request & sharing workflows.

### IMPORTANT

This API is not publicly available. Contact your account representative to request access and your tenant ID.

When requesting a person's identity or part thereof, you must use their personal email and phone. This ensures a person has enduring access, regardless of changes to employment or other circumstances.

Identity Request Flow
---------------------

```mermaid
sequenceDiagram
  participant C as Client
  participant A as API
  participant U as User


  C->>A: POST /identity/request (seed data, purpose, return_url)
  A-->>C: 200 OK (access_request_code, identity_session_code, redirect_url)
  C->>U: Redirect to redirect_url
  U->>U: Complete identity verification
  A->>C: POST webhook (access_request_code, access_token)
  C-->>A: 200 OK
  C->>A: GET /identity/response/{access_request_code}/{identity_session_code} with X-Access-Token header
  A-->>C: 200 OK (identity data)
  U->>C: Redirect to client
```

### OBTAINING KEYS

[Contact us](https://truevault.com.au/contact-us) to obtain a **Tenant ID** to begin integrating the TrueVault API.

Client API keys (used to generate access tokens) are generated and managed via your TrueVault User Portal. API keys can be generated by your users, and centrally managed for your organisation.

Learn more in the [Authentication guide](/rest-api-reference/api-token).

### SUBSCRIBING TO WEBHOOKS

Webhooks for receiving identity results are also configured via your TrueVault User Portal.

Learn more in the [Webhook Response guide](/rest-api-reference/identity/usdwebhook_url).

### API FUNCTIONALITY

This API allows you to:

*   Request TrueIdentity partial/full credential sharing

*   Retrieve verification results

*   Manage identity requests

*   Issue a new Verifiable Credential to an individual

*   Retrieve the details or original file of a Verifiable Credential you issued

*   Query the status and version details of the API