> ## Documentation Index
> Fetch the complete documentation index at: https://developers.argosidentity.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Getting Started

> The ID check API is a solution designed to help enterprise clients manage KYC (Know Your Customer) and AML (Anti-Money Laundering) processes more systematically and efficiently. This API supports seamless integration with existing systems and provides features to securely handle and manage user data.

## Key Features

The ARGOS KYC API offers the following core functionalities:

* KYC Data Submission and Management: Create, retrieve, update, and delete customer information.
* AML Checks and Report Retrieval: Request AML checks and review results.
* Image Processing: Upload and manage ID documents and other required images.

## API Endpoints

The ARGOS KYC API follows a RESTful architecture and provides the following key endpoints:

<CardGroup cols={3}>
  <Card title=" POST/Submission" icon="person-circle-plus" href="/en/idcheck/api-reference/api-reference-guide/post-submission">
    Submit KYC Data
  </Card>

  <Card title="PATCH/Submission" icon="person-chalkboard" href="/en/idcheck/api-reference/api-reference-guide/patch-submission">
    Update KYC Data
  </Card>

  <Card title="GET/Submission" icon="person-circle-check" href="/en/idcheck/api-reference/api-reference-guide/get-submission">
    Retrieve KYC Data
  </Card>

  <Card title="DELETE/Submission" icon="person-circle-xmark" href="/en/idcheck/api-reference/api-reference-guide/delete-submission">
    Delete KYC Data
  </Card>

  <Card title="PARTIAL-DELETE/Submission" icon="person-circle-xmark" href="/en/idcheck/api-reference/api-reference-guide/partial-delete-submission">
    Partial-Delete KYC Data Components
  </Card>

  <Card title="REVIEW/Submission" icon="radar" href="/en/idcheck/api-reference/api-reference-guide/post-client-review">
    Reviewing pending cases
  </Card>

  <Card title="GET/Image" icon="image" href="/en/idcheck/api-reference/api-reference-guide/get-image">
    Retrieve Images
  </Card>

  <Card title="PUT/Image" icon="images" href="/en/idcheck/api-reference/api-reference-guide/put-image">
    Upload/Update Images
  </Card>

  <Card title="GET/Report/AML" icon="file-chart-column" href="/en/idcheck/api-reference/api-reference-guide/aml_data/aml_search/Get-Aml-Report">
    Retrieve AML Reports
  </Card>

  <Card title="POST/AML" icon="radar" href="/en/idcheck/api-reference/api-reference-guide/aml_data/aml_search/Post-Aml">
    Request AML Checks
  </Card>

  <Card title="POST/AML Ongoing" icon="plus" href="/en/idcheck/api-reference/api-reference-guide/aml_data/aml_ongoing/Post_Ongoing_Monitoring">
    Register AML Ongoing Monitoring recordId
  </Card>

  <Card title="GET/AML Ongoing" icon="magnifying-glass" iconType="regular" href="/en/idcheck/api-reference/api-reference-guide/aml_data/aml_ongoing/Get_Ongoing_Monitoring">
    Retrieve AML Ongoing Monitoring recordId
  </Card>

  <Card title="DELETE/AML Ongoing" icon="trash" href="/en/idcheck/api-reference/api-reference-guide/aml_data/aml_ongoing/Delete_Ongoing_Monitoring">
    Delete AML Ongoing Monitoring recordId
  </Card>

  <Card title="POST/Token" icon="arrow-up-from-bracket" iconType="regular" href="/en/idcheck/api-reference/api-reference-guide/post-token">
    Request registering Private tokens
  </Card>

  <Card title="GET/Token" icon="download" iconType="regular" href="/en/idcheck/api-reference/api-reference-guide/get-token">
    Request downloading Private tokens
  </Card>

  <Card title="DELETE/Token" icon="shredder" iconType="regular" href="/en/idcheck/api-reference/api-reference-guide/delete-token">
    Request deleting Private tokens
  </Card>

  <Card title="GET/Projects" icon="download" iconType="regular" href="/ko/idcheck/api-reference/api-reference-guide/get-projects">
    Request to view project configuration
  </Card>
</CardGroup>

## Important Notes

### Understanding Our ID check APIs

Our ID check APIs are designed to seamlessly transfer data, acting as a conduit for information moving both into and out of the ARGOS system. Think of them as secure pipelines: you can use them to bring external data into ARGOS, or to extract data from ARGOS for use in other applications. Their primary function is efficient data movement, ensuring your information flows where it needs to go.

### Data Handling and Limitations

It's crucial to understand that while these APIs are excellent for data transfer, they do not process or validate the data itself. This means if you use a POST submission API to send data to ARGOS, or a PUT Image API to upload images, the system won't automatically approve or reject the results. The APIs facilitate the transfer, but any subsequent data processing, validation, or decision-making would not work.

### Verify Module for Custom UI Development

For customers who want to utilize ID check functionality through their own UI, we recommend using the Verify module. Verify is a flexible tool that provides ARGOS functionality in API format.

<Warning>
  **Considerations When Using the Verify Module**

  * **No Built-in Database**: Requires building your own database
  * **No Built-in Processing**: All data processing logic must be implemented by you
  * **No Dashboard**: No web interface provided for submission management
  * **Complete Self-Configuration**: You must configure everything yourself - connecting all features, storage, and management

  If your goal is to provide API-based services to clients, ARGOS is willing to provide support for integration and connectivity. For more detailed information, please refer to the [Verify Getting Started page](https://dev.argosidentity.com/verify/getting-started).
</Warning>

## API Key

The ID Check API key plays a vital role in authenticating and authorizing client and server requests. It ensures that the requester's credentials are validated, and ARGOS Identity provides the appropriate response.

## How to Access the API Key

<img height="200" src="https://mintcdn.com/argosidentity/vvIXrgN7nH3s-8tI/images/api-reference/api-key.png?fit=max&auto=format&n=vvIXrgN7nH3s-8tI&q=85&s=6868613ab9775ce06ff1d0cf7201e6ab" data-path="images/api-reference/api-key.png" />

<Steps>
  <Step title="Log in to the Dashboard">
    Log in to the ID Check [Dashboard](https://idcheck.argosidentity.com/).
  </Step>

  <Step title="Access the Settings Menu">
    Click on the `Settings` menu in the top navigation bar of the dashboard.
  </Step>

  <Step title="Navigate to the Access Management Page">
    From the `General` section in the left sidebar, select `Access Management`.
  </Step>

  <Step title="Enter Webhook URL">
    Locate the `API Key` section, click the icon to copy the API key, and store it securely.
  </Step>

  <Step title="Request Header Structure">
    Locate the `API Key` section, click the icon to copy the API key, and store it securely.
  </Step>

  <Step title="Implement API Integration">
    Implement and test the API integration in your development environment.
  </Step>

  <Step title="Switch to Production">
    Transition to the production environment and begin processing live data.
  </Step>
</Steps>

## HTTP Response Status Codes

HTTP response codes are used to indicate the status of a request. Each code represents the result of the request, following these rules:

* `2xx`: Successful request
* `4xx`: Client error
* `5xx`: Server error

| HTTP Status Code |                                Message                               |                                                                   Description                                                                   |
| :--------------: | :------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------------: |
|       `200`      |                                  OK                                  |                                                     The request was successfully processed.                                                     |
|       `400`      |                    Invalid Query String parameters                   |      The request cannot be processed. Required parameters are missing or incorrectly formatted. Please check your request parameters again.     |
|       `403`      | User is not authorized to access this resource with an explicit deny |                                Access denied. Access was attempted from an IP not registered in the IP whitelist.                               |
|       `403`      |                               Forbidden                              |                                             Access denied. An incorrect API key may have been used.                                             |
|       `413`      |                       Request Entity Too Large                       | The request is too large. The request contains data that exceeds the size the server can process. Please reduce the request data and try again. |
|       `500`      |                         Internal Server Error                        |                A server error occurred. There may be an issue with the ARGOS server. In this case, please contact the ARGOS team.               |
|       `502`      |                              Bad Gateway                             |               The server received an invalid response from the upstream server. Please try again later or contact the ARGOS team.               |

Simplify your KYC and AML processes, enhance regulatory compliance, and improve customer onboarding experiences using the ARGOS ID Check API.