HomeRecipesAPI ReferenceGuides
API Reference

Onboard AMLock Individual Client

post
https://apicenter-uat.network.global/api/v1/onboarding/client/amlock/individual

Onboards an individual client in AMLock.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Individual customer onboarding request forwarded to AMLOCK.

string

Unique alphanumeric identifier for this onboarding/screening request. Generated server-side if omitted.

string

Scan status for the request.

string

Bank Customer Identification File (CIF) / client number.

string

Customer's full legal name (short display name).

string

Customer's Tax Identification Number.

string

Date the customer record was opened / created (ISO-8601).

boolean

Whether the customer is a resident (true) or non-resident (false).

basicDetails
object
required

Core prospect / customer details required for AML screening.

personalDetails
object

Personal details block (individual customers).

employmentDetails
object

Employment and business / occupation details block.

addresses
object

Permanent and correspondence addresses plus contact numbers.

identityProofDocument
object

Primary identity proof document (simplified view of the main KYC document).

idDocumentDetailsList
array of objects

Full list of ID and KYC documents with all available metadata.

idDocumentDetailsList
taxRegulatoryDetails
object

Tax and regulatory details (FATCA / CRS). taxId is at top-level as taxNumber.

relatedPartiesDetailsList
array of objects

List of related parties associated with the customer.

relatedPartiesDetailsList
accountProductRelationshipsDetails
object

Account / product relationship details.

Biometrics
object

Biometric verification details.

Headers
string

The W3C Trace Context traceparent header for distributed tracing.
It helps propagate trace information across services.
For more details, refer to the official Trace Context documentation.

string

A unique identifier to ensure the request is processed only once, preventing duplicate operations (e.g. retries).

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 28 days ago

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*

Updated 28 days ago