/
Stop review of an AML che...

Stop review of an AML check

Request

Stops the manual review process for an AML check with a specified ID.

This operation also sets the AML check reviewStartTime and the reviewer information to null. Use this operation when the reviewer must stop the review. For example, if the reviewer must take a break, or ends a shift.

Security
SecretApiKey or JWT
Path
idstring, <= 50 characters^[@~\-\.\w]+$required

ID of the resource.

curl -i -X POST \
  'https://www.rebilly.com/_mock/catalog/all/aml-checks/{id}/stop-review' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

AML document review stopped.

Headers
Locationstring, (uri)

Location of the related resource.

Example:"https://api.rebilly.com/example"
X-RateLimit-Limitinteger

Total number of rate limit tokens for this request within a rate limit period. For more information, see Rate limits.

Example:3600
X-RateLimit-Remaininginteger

Remaining number of rate limit tokens for this request within the rate limit period. For example, in the sandbox environment, rate limits for non-GET endpoints are set at 3000 requests per 10 minutes.

Example:3600
Bodyapplication/json
idstring, <= 50 characters

Unique resource ID.

Example:"aml_chk_0YV8XJT2ZWDR398Q8NFEM7DEPM"
createdTimestring, (date-time)(CreatedTime)read-only

Date and time when the resource is created. This value is set automatically when the resource is created.

updatedTimestring, (date-time)(UpdatedTime)read-only

Date and time when the resource is updated. This value is set automatically when the resource is updated.

websiteIdstring, <= 50 characters

Website ID associated with the customer.

Example:"web_0YV7DE4Z26DQSA1AC92FBJ7SEG"
reviewerIdstring or null, <= 50 characters

User ID of the person who reviewed the AML check.

Example:"44433322-2c4y-483z-a0a9-158621f77a21"
reviewerTypestring or nullread-only

Type of reviewer for the current review outcome.

Enum:"human""bot"
Example:"bot"
reviewerNamestring or null

First and last name of the person who reviewed the AML check. If the result is inherited, this field is set to "bot".

reviewStartTimestring or null, (date-time)

Date and time when the AML check review is started.

reviewTimestring or null, (date-time)

Date and time when the AML check review is completed.

prioritystring or null

Highest matched priority of all hits within an AML check.

Default:null
sourcestring

Source of the AML check.

Enum:"sign-up""recurring""purchase"
statusstringread-only

Status of the AML check.

Enum ValueDescription
pending-review

Possible AML match detected and waiting to be manually reviewed.

in-review

A manual AML match review is in progress.

no-match

No possible AML match detected.

confirmed-match

Possible AML match manually reviewed and marked as confirmed.

false-positive

Possible AML match manually reviewed and marked as false positive.

customerobject
hitsArray of objects(AML)

List of hits returned during the AML check.

tagsArray of objects(Tag)read-only

List of AML check tags.

provenanceobject or nullread-only

Origin of the AML check result.

noMatchReasonstring or nullread-only

Reason for the no-match result.

Enum:"no_hits_found""mismatched_hits""hits_are_below_relevance_score_threshold""internal_system_error"
Example:"no_hits_found"
noMatchDetailsArray of stringsread-only

List of codes that explain the no-match result.

Example:
[
  "top_hit_not_eligible_for_matching",
  "search_shard_failures"
]
Response
{
  "id": "aml_chk_0YV8XJT2ZWDR398Q8NFEM7DEPM",
  "createdTime": "2019-08-24T14:15:22Z",
  "updatedTime": "2019-08-24T14:15:22Z",
  "websiteId": "web_0YV7DE4Z26DQSA1AC92FBJ7SEG",
  "reviewerId": "44433322-2c4y-483z-a0a9-158621f77a21",
  "reviewerType": "bot",
  "reviewerName": "string",
  "reviewStartTime": "2019-08-24T14:15:22Z",
  "reviewTime": "2019-08-24T14:15:22Z",
  "priority": null,
  "source": "sign-up",
  "status": "pending-review",
  "customer": {
    "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
    "primaryAddress": { … },
    "organizationId": "org_0YVDM8RC7GDADADSBSMW124JA8"
  },
  "hits": [
    { … }
  ],
  "tags": [
    { … }
  ],
  "provenance": {
    "inherited": true,
    "inheritedFromAmlCheckId": "aml_chk_0YV8XJT2ZWDR398Q8NFEM7DEPM",
    "scope": [ … ],
    "reasons": [ … ]
  },
  "noMatchReason": "no_hits_found",
  "noMatchDetails": [
    "top_hit_not_eligible_for_matching",
    "search_shard_failures"
  ],
  "_links": [
    { … }
  ]
}