> ## 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.

# Update Onboarding Settings

> Enable or disable identity verification and AML screening for your branch.

Use this endpoint to control which steps run during the [Verify Customer](/v3/onboarding/verify_customer) call. Changes apply to all subsequent onboarding requests for your branch.

<Note>
  Both `ivs` and `aml` are enabled by default. Disabling `ivs` will also cause AML screening to be skipped, since screening depends on a verified name being returned from the identity check.
</Note>

## Endpoint

```
POST /api/onboarding/settings
```

## Request

### Headers

| Header           | Value              | Required |
| ---------------- | ------------------ | -------- |
| `x-access-token` | Your API key       | Yes      |
| `Content-Type`   | `application/json` | Yes      |

### Body Parameters

| Parameter | Type    | Required | Description                             |
| --------- | ------- | -------- | --------------------------------------- |
| `ivs`     | boolean | No       | Enable or disable identity verification |
| `aml`     | boolean | No       | Enable or disable AML screening         |

You can update one or both settings in a single call. Omitted fields retain their current value.

### Example

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST https://adhere-api.smartcomply.com/api/onboarding/settings \
    -H "x-access-token: YOUR_API_KEY" \
    -H "Content-Type: application/json" \
    -d '{ "aml": false }'
  ```

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

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

  ```javascript Node.js theme={null}
  const response = await fetch("https://adhere-api.smartcomply.com/api/onboarding/settings", {
    method: "POST",
    headers: {
      "x-access-token": "YOUR_API_KEY",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({ aml: false }),
  });
  const data = await response.json();
  ```
</CodeGroup>

## Response

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

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

<ResponseField name="data" type="object">
  The full settings state after the update.

  <Expandable title="data fields" defaultOpen>
    <ResponseField name="ivs" type="boolean">
      Current state of identity verification.
    </ResponseField>

    <ResponseField name="aml" type="boolean">
      Current state of AML screening.
    </ResponseField>
  </Expandable>
</ResponseField>

### 200 OK

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

### Error Responses

| HTTP Status | Message                            | Cause                           |
| ----------- | ---------------------------------- | ------------------------------- |
| `401`       | `"Authorization token is missing"` | No `x-access-token` header      |
| `401`       | `"Authorization failed"`           | Token not recognised or expired |
| `400`       | `"Invalid value for ivs"`          | Value must be a boolean         |
| `400`       | `"Invalid value for aml"`          | Value must be a boolean         |


## OpenAPI

````yaml POST /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:
    post:
      tags:
        - Customer Onboarding
      summary: Update Onboarding Settings
      description: >-
        Enable or disable identity verification (IVS) and AML screening for your
        branch.
      operationId: updateOnboardingSettings
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                ivs:
                  type: boolean
                  description: Enable or disable identity verification
                aml:
                  type: boolean
                  description: Enable or disable AML screening
      responses:
        '200':
          description: Settings saved
        '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

````