---
title: "Create AML client profile"
method: POST
path: "/v2/clients"
tags: ["AML Screening & Monitoring"]
---

# Create AML client profile

`POST /v2/clients`

Use this endpoint to create an AML client profile and upload the client’s data for screening or monitoring. <br /><br /><img src="https://files.readme.io/310d4d3-Inline_Caution.svg" align="left" alt="Important" /> **Important:** Before using this endpoint, see the <a href="https://docs.fourthline.com/docs/aml-integration-api">integration guide</a>.

## Headers

- `Authorization` string, required — The `access_token` returned in your most recent [Create access token](https://docs.fourthline.com/reference/create-access-token) response.

## Request body

- object
  - `providerClientId` string, required — Your unique identifier for the client. <br /><br />Format: No set format <br /><br /> <img src="https://files.readme.io/8eb9022-Inline_Tip.svg" align="left"/>**Tip:** This is the **same** value as your `ClientNumberProvider`.
  - `clientData` object, required — The client’s <Glossary>identity data</Glossary>.
    - `person` object, required — The client’s <Glossary>personal data</Glossary> .
      - `type` 'Natural Person' — The type of client. Set to `Natural Person`.
      - `name` string — The client’s full name. <br /><br />Format: Alphabetical characters, spaces, hyphens, and apostrophes <br /><br />Example: John James Smith
      - `firstName` string, required — The client’s first name and any middle names. <br /><br />Format: Alphabetical characters, spaces, hyphens, and apostrophes <br /><br />Example: `John`
      - `lastName` string, required — The client’s last name. <br /><br />Format: Alphabetical characters, spaces, hyphens, and apostrophes <br /><br />Example: Smith
      - `nationality` string — The client’s nationality. <br /><br />Format: ISO 3166-1 alpha-3 country code <br /><br />Example: BEL
      - `gender` 'Female' | 'Male' | 'Other' | 'Unknown', required — The client’s sex <br /><br />Format: Case sensitive <br />Enum: <br />• `Female`: Female in line with ID document <br />• `Male`: Male in line with ID document <br />• `Other`: ID document contains a value other than `Male` or `Female` <br />• `Unknown`: ID document contains **no** gender field
      - `countryOfBirth` string — The country where the client was born. <br /><br />Format: ISO 3166-1 alpha-3 <br /><br />Example: BEL
      - `placeOfBirth` string — The city where the client was born. <br /><br />Format: Alphabetical characters, spaces, hyphens, and apostrophes <br /><br />Example: Sint-Agatha-Berchem
      - `birthDate` string, required — The client’s date of birth. <br /><br />Format: Date YYYY-MM-DD <br /><br />Example: `1960-10-18`= October 18, 1960
    - `address` object — The client’s address details.
      - `street` string — The street of the client’s address. <br /><br />Format: Alphabetical characters, spaces, hyphens, and apostrophes <br /><br />Example: Rue Jean-Baptiste Jansen
      - `streetNumberPrefix` string — The prefix of the street number <br /><br />Example: A1
      - `streetNumber` integer — The street number of the client’s address. <br /><br />Format: int32 greater than or equal to zero
      - `streetNumberSuffix` string — The suffix of the street number. <br /><br />Format: Alphabetical characters, spaces, hyphens, and numerals <br /><br />Example: 123A
      - `postalCode` string — The zip code of the client’s address. <br /><br />Format: Alphabetical characters, spaces, hyphens, and apostrophes <br /><br />Example: 1082 <br /><br /><img src="https://files.readme.io/ad2486a-Inline_Note.svg" align="left"/>**Note**: We use Google’s Address Validation API and depend on the quality of their data
      - `region` string — The region of the client’s address <br /><br />Format: Alphabetical characters, spaces, hyphens, and apostrophes <br /><br />Example: Brussels Capital Region
      - `city` string — The city of the client’s address. <br /><br />Format: Alphabetical characters, spaces, hyphens, and apostrophes <br /><br />Example: `London`
      - `country` string — The country of the client’s address. <br /><br />Format: ISO 3166-1 alpha-3 <br /><br />Example: BEL
    - `document` object — The client’s ID document data.
      - `documentNumber` string — The number of the client’s <Glossary>ID document</Glossary>.
    - `contact` object — The client’s email address and phone number(s).
      - `email` string — The client’s email address. <br /><br />Format: Maximum 254 characters [_-a-zA-Z0-9.+]+@a-zA-Z0-9 <br /><br />Example: `j.smith@example.com`
      - `phone` string — The client’s landline number. <br /><br />Format: Must include the country code and begin with `00` or `+` **without** spaces <br /><br />Example: 003281123456 **or** +3281123456
      - `mobile` string — The client’s mobile phone number. <br /><br />Format: Must include the country code and begin with `00` or `+` **without** spaces <br /><br />Example: `00324123456789` **or** `+324123456789`
  - `monitoringType` '1' | '2', required — The type of AML client. <br />Enum: <br />• `1`: Screening <br />• `2`: Monitoring
  - `branch` string — Your configuration for this product. <br />Set the string provided by your Fourthline delivery manager.<br />If **not** set, we use your default configuration. <br /><br /><img src="https://files.readme.io/8eb9022-Inline_Tip.svg" align="left"/> **Tip:** Use this parameter for case configuration in older setups.

## Response `201`

The AML client profile was created successfully

- object
  - `id` string — Our unique identifier for the client, returned in the [Create AML client profile](https://docs.fourthline.com/reference/create-aml-client) response. <br /><br />Format: uuid string <br /><br />Example: `790f325a-48c9-4b82-bb53-c0ea128236f0`
  - `providerClientId` string — Your unique identifier for the client. <br /><br />Format: No set format <br /><br /> <img src="https://files.readme.io/8eb9022-Inline_Tip.svg" align="left"/>**Tip:** This is the **same** value as your `ClientNumberProvider`.
  - `clientData` object — The client’s <Glossary>identity data</Glossary>.
    - `person` object — The client’s <Glossary>personal data</Glossary> .
      - `firstName` string — The client’s first name. <br /><br />Format: Alphabetical characters, spaces, hyphens, and apostrophes <br /><br />Example: John
      - `lastName` string — The client’s last name. <br /><br />Format: Alphabetical characters, spaces, hyphens, and apostrophes <br /><br />Example: Smith
      - `nationality` string — The client’s nationality. <br /><br />Format: ISO 3166-1 alpha-3 country code <br /><br />Example: BEL
      - `gender` string — The client’s sex <br /><br />Format: Case sensitive <br />Enum: <br />• `Female`: Female in line with ID document <br />• `Male`: Male in line with ID document <br />• `Other`: ID document contains a value other than `Male` or `Female` <br />• `Unknown`: ID document contains **no** gender field
      - `countryOfBirth` string — The country where the client was born. <br /><br />Format: ISO 3166-1 alpha-3 <br /><br />Example: BEL
      - `placeOfBirth` string — The city where the client was born. <br /><br />Format: Alphabetical characters, spaces, hyphens, and apostrophes <br /><br />Example: Sint-Agatha-Berchem
      - `birthDate` string — The client’s date of birth. <br /><br />Format: Date YYYY-MM-DD <br /><br />Example: `1960-10-18`= October 18, 1960
    - `address` object — The client’s address details.
      - `city` string — The city of the client’s address. <br /><br />Format: Alphabetical characters, spaces, hyphens, and apostrophes <br /><br />Example: `London`
      - `country` string — The country of the client’s address. <br /><br />Format: ISO 3166-1 alpha-3 <br /><br />Example: BEL
    - `document` object — The client’s ID document data.
      - `documentNumber` string — The number of the client’s <Glossary>ID document</Glossary>.
  - `monitoringType` string — The type of AML client. <br />Enum: <br />• `1`: Screening <br />• `2`: Monitoring
  - `creationUtcDateTime` string — The timestamp for when the client profile was created <br /><br />Format: ISO 8601 UTC date and time
  - `updateUtcDateTime` string — The timestamp for when the client profile was last updated. <br /><br />Format: ISO 8601 UTC date and time

## Other responses

- `400` — Invalid request or validation errors

---

[API](https://skmtc.net/fourthline/apis/fourthline-apis.md) · [All operations](https://skmtc.net/fourthline/apis/fourthline-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/fourthline/fourthline-apis/revisions/7991ae7c8383/schema)
