Exceptions

Written by First AML API team
May 2, 2022

We released a new feature to add an exception to either an individual or an entity. Exceptions are where an individual or entity is unable to satisfy the standard verification requirements, so a reporting entity raises an exception to explain why the individual or entity falls outside those requirements.

Added

Mutations

• The addExceptionForCaseIndividual mutation allows adding an exception for a case individual
• The updateExceptionForCaseIndividual mutation allows updating an exception for a case individual
• The addExceptionForCaseEntity mutation allows adding an exception for a case entity
• The updateExceptionForCaseEntity mutation allows updating an exception for a case entity

Query

We can now query exception details of an individual if there is an exception for that individual.

type CaseIndividual {
  ...
  "The exception associated with this individual and case"
  exception: IndividualExceptionDetails
}

type IndividualExceptionDetails {
  "The reason given for adding the exception"
  reason: String!
  "The user display name who added the exception into the platform"
  addedByDisplayName: String
  "The client full name who approved of adding the exception"
  approvedByFullName: String
  "To indicate whether the exception has supporting documents or not"
  hasSupportingDocuments: Boolean!
  "The date time the exception was created on."
  createdOn: DateTime!
  "The date time the exception was updated on."
  updatedOn: DateTime!
  "Type of exception"
  exceptionType: ExceptionType!
  "Whether the exception is resolved or not"
  isResolved: Boolean!
  "The user display name who resolved the exception"
  resolvedByName: String
}

We can now query exception details of an entity if there is an exception for that entity.

type CaseEntity {
  ...
  "The exception associated with this entity and case"
  exception: EntityExceptionDetails
}

type EntityExceptionDetails {
  "The reason given for adding the exception"
  reason: String!
  "The user display name who added the exception into the platform"
  addedByDisplayName: String
  "The client full name who approved of adding the exception"
  approvedByFullName: String
  "To indicate whether the exception has supporting documents or not"
  hasSupportingDocuments: Boolean!
  "The date time the exception was created on."
  createdOn: DateTime!
  "The date time the exception was updated on."
  updatedOn: DateTime!
  "Type of exception"
  exceptionType: ExceptionType!
  "Whether the exception is resolved or not"
  isResolved: Boolean!
  "The user display name who resolved the exception"
  resolvedByName: String
}

Permanent exceptions and temporary exceptions feature has been enabled for all API clients from the 2nd of May 2022.

---