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

# Get Onboarding Settings

> Retrieve the current identity verification and AML screening settings for your branch.

## Endpoint

```
GET /api/onboarding/settings
```

## Request

### Headers

| Header           | Value        | Required |
| ---------------- | ------------ | -------- |
| `x-access-token` | Your API key | Yes      |

### Example

<CodeGroup>
  ```bash cURL theme={null}
  curl https://adhere-api.smartcomply.com/api/onboarding/settings \
    -H "x-access-token: YOUR_API_KEY"
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      "https://adhere-api.smartcomply.com/api/onboarding/settings",
      headers={"x-access-token": "YOUR_API_KEY"},
  )
  print(response.json())
  ```

  ```javascript Node.js theme={null}
  const response = await fetch("https://adhere-api.smartcomply.com/api/onboarding/settings", {
    headers: { "x-access-token": "YOUR_API_KEY" },
  });
  const data = await response.json();
  ```
</CodeGroup>

## Response

<ResponseField name="status" type="string">
  `"success"` on a successful request.
</ResponseField>

<ResponseField name="message" type="string">
  `"Settings retrieved"`
</ResponseField>

<ResponseField name="data" type="object">
  <Expandable title="data fields" defaultOpen>
    <ResponseField name="ivs" type="boolean">
      Whether identity verification is enabled for this branch. Defaults to `true`.
    </ResponseField>

    <ResponseField name="aml" type="boolean">
      Whether AML screening is enabled for this branch. Defaults to `true`.
    </ResponseField>
  </Expandable>
</ResponseField>

### 200 OK

```json theme={null}
{
  "status": "success",
  "message": "Settings retrieved",
  "data": {
    "ivs": true,
    "aml": true
  }
}
```

### Error Responses

| HTTP Status | Message                            | Cause                           |
| ----------- | ---------------------------------- | ------------------------------- |
| `401`       | `"Authorization token is missing"` | No `x-access-token` header      |
| `401`       | `"Authorization failed"`           | Token not recognised or expired |


## OpenAPI

````yaml GET /api/onboarding/settings
openapi: 3.0.3
info:
  title: Adhere API
  description: >-
    Identity verification, credit checks, transaction monitoring, and loan fraud
    detection across Africa.
  version: 3.0.0
servers:
  - url: https://adhere-api.smartcomply.com
    description: Production
security:
  - ApiKeyAuth: []
tags:
  - name: Nigeria KYC
  - name: Kenya KYC
  - name: Ghana KYC
  - name: Rwanda KYC
  - name: Uganda KYC
  - name: Biometrics
  - name: Individual Credit
  - name: Business Credit
  - name: Transaction Monitoring
  - name: Transaction Screening
  - name: Transaction KYC
  - name: Loan Fraud
  - name: User Journey
paths:
  /api/onboarding/settings:
    get:
      tags:
        - Customer Onboarding
      summary: Get Onboarding Settings
      description: Retrieve the current IVS and AML toggle settings for your branch.
      operationId: getOnboardingSettings
      responses:
        '200':
          description: Settings retrieved
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  responses:
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            type: object
            properties:
              status:
                type: string
                example: failed
              message:
                type: string
                example: Authentication credentials were not provided.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-access-token
      description: Your Adhere API secret key

````