AmlClientDto - SodiumHQ API Schema

Properties

Name	Type	Description
id	string
name	string
externalReference	string	The platform's own reference for the client. Firmcheck stores the Sodium client code here on create, so it identifies a client in a list that cannot be searched.
The platform's own reference for the client. Firmcheck stores the Sodium client code here on create, so it identifies a client in a list that cannot be searched.
isIndividual	boolean
isSoleTrader	boolean	The client is held as a sole trader on the platform (Firmcheck only; false on Xama).
The client is held as a sole trader on the platform (Firmcheck only; false on Xama).
regNumber	string
contacts	array of AmlContactDto
status	enum	Active Pending Archived
Active Pending Archived
riskLevel	enum	Low Normal High Medium
Low Normal High Medium
determinationStatus	enum	NotStarted InProgress Ready InReview Complete ActionRequired Cancelled
NotStarted InProgress Ready InReview Complete ActionRequired Cancelled
nextReviewDate	string	When the platform expects the client to be reviewed next. Null until a determination has completed, and always null on Xama.
When the platform expects the client to be reviewed next. Null until a determination has completed, and always null on Xama.
externalUrl	string
createdDate	string

{
  "id": "string",
  "name": "string",
  "externalReference": "string",
  "isIndividual": false,
  "isSoleTrader": false
}