Preflight Check Callback

Version: 3.0.0

Method

POST

Url

https://{YOUR_SERVICE_URL}/(preflight_check: 11)

This API endpoint handles callbacks for preflight checks, initiator will send the request for check whether you will accept this funds, for your side it could be human review or sanction screening results, you can decide to tell the initiator or not, this is only suitable in scenario: Before on chain, and you're beneficiary.

Authentication

No authentication

Path Parameters

No path parameters

Query Parameters

No query parameters

Request Body (Optional)

Schema

requestId

RequiredString

requestId is the unique id for all transaction, the same travelrule-request invoke process flow should be using same requestId, the recommend format is: "[YOUR_VASP_NAME]-[UUIDv4]"

Min Length0

Max Length64

Pattern

[\w\d_=-]+

Example

testexchange-189e9948-64c7-4a6c-bb4f-859c173321c5

Example

{
  "requestId": "testexchange-189e9948-64c7-4a6c-bb4f-859c173321c5"
}

Responses

Status 200

OK

JSON Content

Schema

[+]data

OptionalObject

verifyMessage

OptionalString

verifyStatus

RequiredInteger (int32)

VerifyStatus

Example

100000

Example

{
  "data": {
    "preflightCheckStatus": "string",
    "preflightCheckMessage": "string"
  },
  "verifyStatus": 100000,
  "verifyMessage": "string"
}

Status HTTP Status: 200, VerifyStatus: 100000

JSON Content

Schema

[+]data

OptionalObject

verifyMessage

OptionalString

verifyStatus

RequiredInteger (int32)

VerifyStatus

Example

100000

Example

{
  "data": {},
  "verifyStatus": 100000,
  "verifyMessage": "string"
}

Response Example

HTTP Status: 200, VerifyStatus: 100000

{"verifyStatus": 100000,"verifyMessage": "Verify Success"}