Appearance
Get Request
About 469 wordsAbout 2 min
GET /public/v1/requests/{type}/{id}
Path Variables
| Name | Type | Required | Rule | Description |
|---|---|---|---|---|
| type | string | Mandatory | kyc,withdrawal,deposit | |
| id | string | Mandatory |
Expected HTTP status code
- 200
Response
| Name | Type | Description |
|---|---|---|
| id | string | Request unique ID |
| type | string | Request type: kyc, deposit, withdrawal |
| status | string | Request status |
| user_id | string | User ID |
| ip | string | IP address |
| language | string | Language code |
| user_type | string | User type |
| created_at | string | Creation time |
| created_by | string | Creator ID or name |
| timestamp | string | Timestamp |
| auto | boolean | Whether the request is automated |
| pre_step | number | Previous step index |
| pre_event | string | Previous event |
| user | object | User details object |
| user.id | string | User ID |
| user.name | string | User name |
| user.email | string | User email |
| user.phone | object | User phone object |
| user.phone.country_code | string | User phone country code |
| user.phone.number | string | User phone number |
| user.group_id | string | User group ID |
| user.group_name | object | User group name (localized) |
| user.referrer_id | string | User referrer ID |
| user.referrer_name | string | User referrer name |
| user.rank_id | string | User rank ID |
| user.status | string | User status |
| user.tier | number | User tier (if applicable) |
| flow | object | Workflow details |
| flow.current | number | Current step index |
| logs | array | Request logs |
| logs[].event | string | Log event name |
| logs[].timestamp | string | Log timestamp |
| logs[].admin | string | Admin name involved |
| logs[].prevData | object | Previous data (if update event) |
| logs[].newData | object | New data (if update event) |
| KYC Specific | ||
| form_id | string | KYC form ID |
| name | string | Name submitted in KYC |
| address | string | Address submitted in KYC |
| date_of_birth | string | Date of birth |
| gender | string | Gender |
| identity_number | string | Identity number |
| nationality | string | Nationality |
| phone | object | Phone submitted in KYC |
| phone.country_code | string | Phone country code |
| phone.number | string | Phone number |
| location | object | Location details |
| location.country | string | Country |
| location.state | string | State |
| location.city | string | City |
| postal_code | string | Postal code |
| identity_type | string | Identity document type |
| identity_doc | array | Identity documents |
| alt_identity_doc | array | Alternative identity documents |
| address_doc | array | Address documents |
| bank_card_doc | array | Bank card documents |
| selfie_doc | array | Selfie documents |
| submitted_at | string | Submission time (KYC) |
| locked | boolean | Whether the request is locked |
| lock_time | string | Lock time |
| unlock_time | string | Unlock time |
| review_time | string | Review time |
| Deposit Specific | ||
| pay_status | string | Payment status |
| payment_platform | string | Payment platform |
| payment_method | string | Payment method |
| payment_method_label | object | Payment method label (localized) |
| payment_currency | string | Payment currency |
| payment_total | string | Total payment amount |
| payment_fee | number | Payment fee |
| payment_id | string | Payment ID |
| channel_id | string | Payment channel ID |
| method_id | string | Method ID |
| pay_time | string | Payment time |
| Withdrawal Specific | ||
| withdrawal_method | string | Withdrawal method |
| withdrawal_method_id | string | Withdrawal method ID |
| withdrawal_method_label | object | Withdrawal method label (localized) |
| withdrawal_platform | string | Withdrawal platform |
| withdrawal_currency | string | Withdrawal currency |
| withdrawal_total | string | Total withdrawal amount |
| withdrawal_fee | string | Withdrawal fee |
| converted_amount | number | Converted amount |
| withdrawal_channel | string | Withdrawal channel |
| Trading Details (Deposit/Withdrawal) | ||
| trading_platform | string | Trading platform (e.g., mt4) |
| trading_id | number | Trading account ID |
| trading_currency | string | Trading currency |
| trading_amount | string | Trading amount |
| rate | number | Exchange rate |
| trading_connection_id | string | Trading connection ID |
| form_data | object | Dynamic form data |
Error
| Code | Type | Description |
|---|---|---|
400 | request_not_found | Request is not found |