POST/AML

Definition

  • 이미 생성된 Submission 에 대하여 AML Search 를 진행합니다.

Input data

Parameter
Type
Required
Description

submissionId

String

O

제출건의 고유 ID (= submissionId)

Output Data

Response
Description

message

요청 결과에 대한 메세지

result

AML Search 결과

raw_data

AML 스크리닝 결과의 원시 데이터를 반환하는 객체

Error Codes (400 error)

errorCode
Message
설명

invalid_payload

Invalid payload.

요청 본문(페이로드) 가 확인되지 않음

missing_parameter

submissionId is required.

필수 파라미터가 누락됨

invalid_submissionId

Cannot find submission.

유효하지 않은 Submission ID

invalid_country

The nationality is invalid : {nationality}

유효하지 않은 국가명

request_failed

Fail to search AML.

데이터 처리 중 알 수 없는 에러. (CS 관리자 문의)

Request URL

  • URL과 x-api-key를 반드시 입력해 주어야 합니다.

curl -X POST "<https://rest-api.argosidentity.com/v3/submission/aml>" \\
-H "x-api-key: {yourAPIKey}" \\

Sample Request

  • Body /Raw Json 형식으로 제출합니다.

  • 단 건 제출만 가능합니다.

curl --location '<https://rest-api.argosidentity.com/v3/submission/aml>' \\
--header 'Content-Type: application/json' \\
--header 'x-api-key: {yourAPIKey}' \\
--data '{
    "submissionId" : "sampleSubmissionId11"
}'

Sample Response

{
    "message": "complete to search AML.",
    "result": "Not Screened",
    "raw_data" : {...}
}

Last updated