> For the complete documentation index, see [llms.txt](https://docs.vida.id/identity-stack/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.vida.id/identity-stack/verify/indonesia-verification/integration/api.md).

# API

The VIDA Identity Verification API is a service that allows partners to confirm the identity of their users by sending their details in a request to the API. The API performs a set of checks and validations on the provided information to verify the user's identity and returns a unique transaction ID and a response indicating the outcome of the verification.

An identity verification request made through the VIDA API goes through several stages, including authorisation, VIDA services check, and verification at authoritative sources.

1. **Authorisation**: This step ensures that the user has the correct permissions to access the API and perform the identity verification. The client service establishes a secure connection with the VIDA services by providing the necessary credentials, such as client ID, and client secret.
2. **VIDA services API call**: Once the authorization is established, the client service can make API calls to the VIDA services, including requests for identity verification, status check, or data retrieval. The client service sends the user's details, such as their name, address, and ID number, in a request to the API. The request also goes through validation check to ensure that the user's input meets the required format and standards for the API to process the request. Additionally, liveness check ensures that the user is a live person, not a recorded or synthetic image. And a quota check ensures that the user hasn't exceeded the allotted rate limit for API requests.
3. **Verification at authoritative sources**: The API performs a set of checks and validations on the provided information to verify the user's identity. These checks may include comparing the provided information against official government records, checking for discrepancies or inconsistencies, and performing a facial recognition analysis to compare the user's photo with their ID photo.

Once the verification process is complete, the API returns a unique transaction ID and a response indicating the outcome of the verification

<figure><img src="/files/A2mMfnXYtLOcqOwn6Ic8" alt=""><figcaption></figcaption></figure>

### Case : Success

If the request passes through all these stages, it is sent to authoritative sources to verify the user's personal information. Once the authoritative sources have verified the information and returned the results, the API sends a response to the user with the results of the verification.

<figure><img src="/files/Nh7KeGgp2fhztcvi1dOw" alt=""><figcaption></figcaption></figure>

#### Case : Error

In case the request fails at any of the stages, the API responds with a corresponding status code and error message. For example, if the user fails the liveness check, the API will return an error message and a status code indicating that the liveness check failed.

<figure><img src="/files/8uyramdkQqaEa4D5nrCl" alt=""><figcaption></figcaption></figure>