### Using This Collection (Postman)

Source: https://developers.ridx.io/index

Instructions on how to set up and use the RapidID API collection in Postman, including environment variables for authentication and environment selection.

```APIDOC
## Using This Collection (Postman)

### Description
This section guides users on setting up the RapidID API collection within Postman for testing and integration. It details the necessary environment variables and how to use the 'Run in Postman' button.

### Method
Not applicable (Postman specific instructions)

### Endpoint
Not applicable

### Parameters
#### Environment Variables (Postman)
- **access_token** (string) - Required - Your authentication token obtained from the RapidID account.
- **environment** (string) - Required - Must be either `live` or `sandbox` to match the `access_token`.

### Request Example
(No direct request example, refers to Postman setup)

### Response
(No specific response example, refers to Postman setup)

### Notes
- Ensure your current environment in Postman is set correctly.
- Use the 'Run in Postman' button for easy collection import and setup.
- Each endpoint includes examples for different use cases and potential error responses.
```

--------------------------------

### Glossary

Source: https://developers.ridx.io/index

Provides definitions for common acronyms and terms used throughout the RapidID API documentation.

```APIDOC
## Glossary

### Description
This section defines key acronyms and terms used in the RapidID API documentation to ensure clarity and understanding.

### Terms
- **AML** : Anti-Money Laundering
- **OFAC** : Office of Foreign Assets Control
- **PEP** : Politically Exposed Persons
- **ASIC** : Australian Securities and Investments Commission
- **DVS** : Document Verification Service
- **KYC** : Know Your Customer
- **eidv** : Electronic Identity Verification
- **CVS** : China Verification Service
- **CNBC** : China Banking Card
- **NVS** : New Zealand Verification Service
- **DIABC** : Department of Internal Affairs Birth Certificate
- **DIACT** : Department of Internal Affairs Citizenship Certificate
- **NZTADL** : New Zealand Transport Agency Drivers Licence
- **DIAPS** : Department of Internal Affairs Passport Document
- **NZTAMVR** : Department of Internal Affairs Motor Vehicle Registration
- **IRN** : Individual Reference Number
- **CTF** : Counter-Terrorism Financing
```

--------------------------------

### Authentication

Source: https://developers.ridx.io/index

To send an authenticated request to the RapidID API, you must provide your API token in the `Token` header within each request.

```APIDOC
## Authentication

### Description
To send an authenticated request to the RapidID API, you must provide your API token in the `Token` header within each request.

### Method
Not applicable (Header parameter)

### Endpoint
Not applicable

### Parameters
#### Header Parameters
- **Token** (string) - Required - Your API token for authentication.

### Request Example
```
Token f64a1b2c3d4e5f67890a1b2c3d4e5f67890a
```

### Response
(No specific response example for authentication, as it's a header)

### Error Handling
Incorrect or missing tokens will result in authentication errors.
```

--------------------------------

### Error Responses

Source: https://developers.ridx.io/index

Describes the general approach to error handling for RapidID API endpoints, noting that custom error responses are provided for incorrect request data.

```APIDOC
## Error Responses

### Description
All RapidID API endpoints are designed to return custom error responses when incorrect request data is provided. An example of the error response structure is available for each endpoint in its respective documentation.

### Method
Not applicable (General error handling)

### Endpoint
Not applicable

### Parameters
(No specific parameters, refers to individual endpoint error examples)

### Request Example
(No specific request example, refers to individual endpoint error examples)

### Response
#### General Error Response Structure
- **code** (integer) - An error code.
- **message** (string) - A human-readable error message.
- **details** (object) - Optional - Additional details about the error.

### Response Example
```json
{
  "code": 400,
  "message": "Invalid request data.",
  "details": {
    "field": "example_field",
    "reason": "Value is missing."
  }
}
```
```

=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.