Get suspicion status history

GET 
/Customer/SuspicionStatusHistory/:customerCode

Get suspicion status history

Request

Path Parameters

customerCode stringrequired

The unique identifier of the customer whose suspicion status history is being requested.

Responses

200

Returns the suspicion status history of the customer.

application/json

Schema

Schema

• Array [
custCode stringnullablerequired

The unique code identifying the customer.

slChecksumVersion stringnullablerequired

The sanction list checksum version used for the screening.

isSuspicious booleanrequired

Indicates whether the customer is flagged as suspicious.

slEntryCode stringnullablerequired

The entry code from the matched sanction list.

slSource stringnullablerequired

The source of the sanction list match.

state stringnullablerequired

The current state of the suspicion record.

code stringnullablerequired

The unique code identifying this entity.

documentCode stringnullablerequired

The document code associated with the transaction.

creationDate stringnullablerequired

The date when this record was created.

createdBy stringnullablerequired

The username or identifier of the user who created this record.

updatedBy stringnullablerequired

The username or identifier of the user who last updated this record.

lastname stringnullablerequired

The customer's primary last name.

firstname stringnullablerequired

The customer's first name.

middlename stringnullablerequired

The customer's middle name.

fullname stringnullablerequired

The full name of the customer (computed from first and last name).

taxCode stringnullablerequired

The customer's tax identification number.

code1 stringnullablerequired

An additional classification code (purpose-specific).

code2 stringnullablerequired

An additional classification code (purpose-specific).

code3 stringnullablerequired

An additional classification code (purpose-specific).

code4 stringnullablerequired

An additional classification code (purpose-specific).

identificationNumber stringnullablerequired

The identification number used for the screening match.

• ]

Example (from schema)

[
  {
    "custCode": "string",
    "slChecksumVersion": "string",
    "isSuspicious": true,
    "slEntryCode": "string",
    "slSource": "string",
    "state": "string",
    "code": "string",
    "documentCode": "string",
    "creationDate": "string",
    "createdBy": "string",
    "updatedBy": "string",
    "lastname": "string",
    "firstname": "string",
    "middlename": "string",
    "fullname": "string",
    "taxCode": "string",
    "code1": "string",
    "code2": "string",
    "code3": "string",
    "code4": "string",
    "identificationNumber": "string"
  }
]

400

If the customerCode is invalid or missing.

application/json

Schema

Schema

message stringnullablerequired

The error or validation message.

metadata objectnullable
Additional metadata associated with this record.
nullable required
reasons object[]nullable
The list of underlying error reasons.
Array [
message stringnullablerequired
The error or validation message.
metadata objectnullable
Additional metadata associated with this record.
nullable required
reasons undefined[]nullablerequired
The list of underlying error reasons.
]
code int32required

The unique code identifying this entity.

errors object[]nullable
The list of validation errors.
Array [
field stringnullablerequired
The name of the field that failed validation.
message stringnullablerequired
The error or validation message.
]

Example (from schema)

{
  "message": "string",
  "metadata": {},
  "reasons": [
    {
      "message": "string",
      "metadata": {},
      "reasons": [
        null
      ]
    }
  ],
  "code": 0,
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

404

If no suspicion status history is found for the provided customerCode.

application/json

Schema

Schema

message stringnullablerequired

The error or validation message.

metadata objectnullable
Additional metadata associated with this record.
nullable required
reasons object[]nullable
The list of underlying error reasons.
Array [
message stringnullablerequired
The error or validation message.
metadata objectnullable
Additional metadata associated with this record.
nullable required
reasons undefined[]nullablerequired
The list of underlying error reasons.
]
code int32required

The unique code identifying this entity.

errors object[]nullable
The list of validation errors.
Array [
field stringnullablerequired
The name of the field that failed validation.
message stringnullablerequired
The error or validation message.
]

Example (from schema)

{
  "message": "string",
  "metadata": {},
  "reasons": [
    {
      "message": "string",
      "metadata": {},
      "reasons": [
        null
      ]
    }
  ],
  "code": 0,
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

500

If there is an internal server error while fetching the data.

application/json

Schema

Schema

message stringnullablerequired

The error or validation message.

metadata objectnullable
Additional metadata associated with this record.
nullable required
reasons object[]nullable
The list of underlying error reasons.
Array [
message stringnullablerequired
The error or validation message.
metadata objectnullable
Additional metadata associated with this record.
nullable required
reasons undefined[]nullablerequired
The list of underlying error reasons.
]
code int32required

The unique code identifying this entity.

errors object[]nullable
The list of validation errors.
Array [
field stringnullablerequired
The name of the field that failed validation.
message stringnullablerequired
The error or validation message.
]

Example (from schema)

{
  "message": "string",
  "metadata": {},
  "reasons": [
    {
      "message": "string",
      "metadata": {},
      "reasons": [
        null
      ]
    }
  ],
  "code": 0,
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

Loading...