Submit Deposit Questionnaire
Submit Travel Rule questionnaire information for a deposit order that requires a questionnaire.
HTTP REQUEST
POST /api/v1/deposit/compliance/info
Example
Request body example (company sender)
POST /api/v1/deposit/compliance/info
{
"travelRuleOId": "6abf6bd16a63600007325e88",
"type": "company",
"complianceInfo": "{\"companyName\":\"Example Company\",\"tin\":\"example-tax-number\",\"reasonOfTransfer\":\"Business transfer\",\"wallet\":\"OKX\"}"
}
This example uses type: "company" and includes the conditionally required companyName and tin fields. Serialize the questionnaire object with JSON.stringify() before assigning it to complianceInfo; the value sent is a JSON string. All sample values illustrate the request format and must be replaced with the actual order ID and questionnaire values accepted by the endpoint.
Response example
{
"success": true,
"code": "200",
"msg": "success",
"retry": false,
"data": {
"orderId": "6abf6bd16a63600007325e88",
"travelRuleOId": "6abf6bd16a63600007325e88",
"status": "pending",
"failureCode": null
}
}
API KEY PERMISSIONS
This endpoint requires General permission.
REQUEST RATE LIMIT
10 QPS
PARAMETERS
| Param | Type | Mandatory | Description |
|---|---|---|---|
| travelRuleOId | String | Yes | Travel Rule order ID associated with the deposit. |
| type | String | Yes | Deposit sender type: individual (individual) or company (company). |
| complianceInfo | String | Yes | Supplementary questionnaire information, serialized as a JSON string. See the fields below. |
complianceInfo
Serialize the questionnaire fields as a JSON string before assigning the value to complianceInfo.
| Param | Type | Mandatory | Description |
|---|---|---|---|
| companyName | String | Conditional | Company name. Required when type is company. |
| firstName | String | Conditional | Sender's first name. Required when type is individual. |
| lastName | String | Conditional | Sender's last name. Required when type is individual. |
| country | String | No | Country. Available values are obtained from GET /kyc/regions/v4. |
| identityType | String | Conditional | Identity document type. Use TCKN when country is TR; otherwise, use PASSPORT. Required when type is individual. |
| identityNo | String | Conditional | Identity document number. Required when type is individual. |
| reasonOfTransfer | String | Yes | Transfer reason. |
| tin | String | Conditional | Company tax number. Required when type is company. |
| wallet | String | Yes | Wallet or exchange. For non-custodial wallets, enter personal wallets; for custodial wallets, enter the exchange name, such as OKX or Binance. |
RESPONSES
| Param | Description |
|---|---|
| success | Whether the request was successful. |
| code | Result code. The success code is the string "200". |
| msg | Response message, such as success. |
| retry | Retry indicator; false in the example. |
| data | Response data. |
| data.orderId | Order ID. |
| data.travelRuleOId | Travel Rule order ID associated with the deposit. |
| data.status | Order status, such as pending. |
| data.failureCode | Failure code; null in the example. |