# Review an AML check

Reviews an AML check.
Records a decision on each listed hit, then applies `status` to every hit that has no decision yet.
The status of the AML check is calculated from the hit decisions.
If any hit has no decision, the AML check remains in review.
If any hit is a confirmed match, the AML check is a confirmed match.
If every hit is a false positive, the AML check is a false positive.

Endpoint: POST /aml-checks/{id}/review
Version: latest
Security: SecretApiKey, JWT

## Path parameters

- `id` (string, required)
  ID of the resource.

## Response 201 fields

- `id` (string)
  Unique resource ID.
  Example: aml_chk_0YV8XJT2ZWDR398Q8NFEM7DEPM
- `createdTime` (string)
  Date and time when the resource is created. This value is set automatically when the resource is created.
- `updatedTime` (string)
  Date and time when the resource is updated. This value is set automatically when the resource is updated.
- `websiteId` (string)
  Website ID associated with the customer.
  Example: web_0YV7DE4Z26DQSA1AC92FBJ7SEG
- `reviewerId` (string | null)
  User ID of the person who reviewed the AML check.
  Example: 44433322-2c4y-483z-a0a9-158621f77a21
- `reviewerType` (string | null)
  Type of reviewer for the current review outcome.
  Enum: "human", "bot"
- `reviewerName` (string | null)
  First and last name of the person who reviewed the AML check. If the result is inherited, this field is set to "bot".
- `reviewStartTime` (string | null)
  Date and time when the AML check review is started.
- `reviewTime` (string | null)
  Date and time when the AML check review is completed.
- `priority` (string | null)
  Highest matched priority of all hits within an AML check.
- `source` (string)
  Source of the AML check.
  Enum: "sign-up", "recurring", "purchase"
- `status` (string)
  Status of the AML check.
  Enum: "pending-review", "in-review", "no-match", "confirmed-match", "false-positive"
- `customer` (object)
- `customer.id` (string)
  Unique resource ID.
  Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
- `customer.primaryAddress` (object)
  Customer's data at the time of the AML check.
- `customer.primaryAddress.firstName` (string)
  Customer's first name at the time of the AML check.
- `customer.primaryAddress.lastName` (string)
  Customer's last name at the time of the AML check.
- `customer.primaryAddress.dob` (string | null)
  Customer's date of birth.
  Example: 1971-02-14
- `customer.primaryAddress.address` (string | null)
  First line of the customer's street address at the time of the AML check.
  Example: 36 Craven St
- `customer.primaryAddress.address2` (string | null)
  Second line of the customer's street address at the time of the AML check.
- `customer.primaryAddress.city` (string | null)
  Customer's city of residence at the time of the AML check.
  Example: Austin
- `customer.primaryAddress.region` (string | null)
  Customer's region of residence at the time of the AML check.
  Example: Texas
- `customer.primaryAddress.country` (string | null)
  Customer's country of residence at the time of the AML check.
- `customer.primaryAddress.postalCode` (string | null)
  Customer's postal code at the time of the AML check.
  Example: WC2N 5NF
- `customer.organizationId` (string)
  ID of the customer's organization.
  Example: org_0YVDM8RC7GDADADSBSMW124JA8
- `hits` (array)
  List of hits returned during the AML check.
- `hits.firstName` (string)
  First name of the individual, or name of entity.
  Example: Benjamin
- `hits.lastName` (string | null)
  Last name of the individual. This field returns a `null` value for single-named entities.
  Example: Franklin
- `hits.source` (string)
  Describes which list the result is from.
- `hits.sourceType` (array)
  Describes the categories of the individual or entity.
  Example: ["sanctions","enforcements"]
- `hits.gender` (string | null)
  If `type`=`individual`, this field describes the gender of the individual.
- `hits.title` (array | null)
  Individual's job title.
  Example: ["Postmaster General","Ambassador to France","Ambassador to Sweden","Supreme Executive Council of Commonwealth of Pennsylvania"]
- `hits.type` (string)
  Describes whether the source is an individual or an entity.
  Enum: "individual", "entity"
- `hits.legalBasis` (array)
  List of references to legal documents, if they exist.
- `hits.regime` (string | null)
  Describes the government, administration, or political entity.
  Example: United States Government
- `hits.confidence` (string)
  Degree of confidence in the source list information.
  Enum: "weak", "medium", "strong", "very-strong"
- `hits.nationality` (string)
  Nationality of the individual or entity.
- `hits.address` (array)
  Addresses associated with the individual or entity.
- `hits.address.address` (string | null)
  Street address line 1.
- `hits.address.address2` (string | null)
  Street address line 2.
- `hits.address.city` (string | null)
  City.
- `hits.address.region` (string | null)
  State, province, or region.
- `hits.address.country` (string | null)
  Country.
- `hits.address.birthplace` (boolean)
  Individual's place of birth.
- `hits.dob` (array)
  One or more possible dates of birth.
- `hits.aliases` (array)
  List of aliases, if any.
- `hits.aliases.firstName` (string)
  First name of alias.
- `hits.aliases.lastName` (string)
  Last name of alias.
- `hits.aliases.authenticity` (string)
  Degree of confidence in the alias.
  Enum: "strong", "weak", "unknown"
- `hits.passport` (array)
  Individual's passport information.
- `hits.passport.number` (string)
  Passport number.
- `hits.passport.registrationDate` (string)
  Passport registration date.
- `hits.comments` (string | null)
  Additional information. This content varies per list.
- `hits.metadata` (object | null)
  Additional metadata on AML sources, when available.
- `hits.metadata.lookupId` (string)
  Direct lookup identifier for the LexisNexis WorldCompliance Online Search Tool.
  Example: 1E66DAD6-A2E2-4DCB-BCAF-8CC92CD1DDEC
- `hits.matchDetails` (object | null)
  Details of the matching logic and confidence scoring.
- `hits.matchDetails.confidenceFactors` (array)
  List of factors that contributed to the confidence score calculation.
- `hits.matchDetails.matchCriteria` (array)
  List of specific criteria that matched against the watchlist.
- `hits.decision` (string | null)
  Reviewer decision for this hit. This value is `null` if the hit has not been decided yet.
  Enum: "confirmed-match", "false-positive", null
- `hits.decisionInherited` (boolean)
  Specifies if the decision is copied from an earlier AML check instead of recorded by a reviewer. The decision is copied from a matching hit on the previous AML check of the same customer or of a related customer, or from the `false-positive` status of an earlier AML check of the same customer or a related customer.
  Example: false
- `hits._links` (array)
  Related links.
- `hits._links.href` (string)
  Link URL.
- `hits._links.rel` (string)
  Type of link.
  Enum: "self"
- `tags` (array)
  List of AML check tags.
- `tags.name` (string, required)
  Unique name for the tag. Tag names are not case-sensitive.
  Example: New
- `tags.type` (string, required)
  Type of tag. Tags of a specific type can only be assigned to corresponding entity types. For example, you can only use customer tags on customers.
  Enum: "customer", "kyc-document", "aml-check"
- `provenance` (object | null)
  Origin of the AML check result.
- `provenance.inherited` (boolean)
  Specifies if the result is inherited from a previous AML check.
  Example: true
- `provenance.inheritedFromAmlCheckId` (string)
  ID of the AML check from which the check inherits its result.
  Example: aml_chk_0YV8XJT2ZWDR398Q8NFEM7DEPM
- `provenance.scope` (array)
  Scope of what is inherited from the source AML check.
  Example: ["status-only"]
- `provenance.reasons` (array)
  Reasons that triggered the inheritance of the result.
  Example: ["customer_duplicated_by_person_exact_match"]
- `noMatchReason` (string | null)
  Reason for the no-match result.
  Enum: "no_hits_found", "mismatched_hits", "hits_are_below_relevance_score_threshold", "internal_system_error"
- `noMatchDetails` (array)
  List of codes that explain the no-match result.
  Example: ["top_hit_not_eligible_for_matching","search_shard_failures"]
- `_links` (array)
  Related links.
- `_links.href` (string)
  Link URL.
- `_links.rel` (string)
  Type of link.
  Enum: "self", "customer"

## Response 401 fields

- `status` (integer)
  HTTP status code.
- `type` (string)
  Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference. It should provide human-readable documentation for the problem type. When this member is not present, its value is assumed to be "about:blank".
- `title` (string)
  Short, human-readable summary of the problem type. Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.
- `detail` (string)
  Human-readable explanation that is specific to this occurrence of the problem.
- `instance` (string)
  URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

## Response 403 fields

- `status` (integer)
  HTTP status code.
- `error` (string)
  Message that describes why the request is forbidden. Most responses use a descriptive message, such as `Not allowed to change security settings`. If the organization requires multi-factor authentication (MFA) and MFA verification has not been completed for the session, this value is `mfa_required`. If MFA verification has not been completed for the session and the operation requires a confirmed session, this value is `mfa_required_for_caller`. This includes turning on `requireMfa` and resetting MFA for a user. If the organization restricts access to a list of IP addresses and the request comes from an IP address that is not in the list, this value is `ip_not_allowed`.
- `organizationId` (string)
  Unique organization identifier. An organization is an entity that represents a company. For more information, see [Obtain an organization ID](https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id).
  Example: org_0YVDM8RC7GDADADSBSMW124JA8
- `type` (string)
  Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference. It should provide human-readable documentation for the problem type. When this member is not present, its value is assumed to be "about:blank".
- `title` (string)
  Short, human-readable summary of the problem type. Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.
- `detail` (string)
  Human-readable explanation that is specific to this occurrence of the problem.
- `instance` (string)
  URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

## Response 404 fields

- `status` (integer)
  HTTP status code.
- `type` (string)
  Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference. It should provide human-readable documentation for the problem type. When this member is not present, its value is assumed to be "about:blank".
- `title` (string)
  Short, human-readable summary of the problem type. Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.
- `detail` (string)
  Human-readable explanation that is specific to this occurrence of the problem.
- `instance` (string)
  URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

## Response 422 fields

- `status` (integer)
  HTTP status code.
- `type` (string)
  Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference. It should provide human-readable documentation for the problem type. When this member is not present, its value is assumed to be "about:blank".
- `title` (string)
  Short, human-readable summary of the problem type. Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.
- `detail` (string)
  Human-readable explanation that is specific to this occurrence of the problem.
- `instance` (string)
  URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
- `invalidFields` (array)
  Invalid field details.
  Example: [{"field":"field1","message":"field1 is invalid"},{"field":"subObject.field2","message":"field2 is invalid"},{"field":"subObject.field2","message":"another error in the field2"}]
- `invalidFields.field` (string)
  Name of the field. Dot notation is used for nested object field names.
- `invalidFields.message` (string)
  Message field.

## Response 429 fields

- `type` (string)
  Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference. It should provide human-readable documentation for the problem type. When this member is not present, its value is assumed to be "about:blank".
  Example: about:blank
- `title` (string)
  Short, human-readable summary of the problem type. Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.
  Example: Rate Limit Exceeded
- `status` (integer)
  HTTP status code.
- `detail` (string)
  Human-readable explanation that is specific to this occurrence of the problem.
  Example: A request cannot be executed because the user has sent too many requests within a certain period of time
- `instance` (string)
  URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.