post
https://api.heleket.com/v1/payment/aml-links
A payment can fall under AML verification and move to the locked status. To unlock the funds, the payer must complete a AML questionnaire — KYC or SoF (Source of Funds).
Request
Query parameters
| Name | Parameter type | Definition |
|---|---|---|
| uuid | stringuuidrequired_without: order_id | Invoice uuid |
| order_id | stringrequired_without: uuid | Invoice order ID |
Parameter type
stringuuidrequired_without: order_idDefinition
Invoice uuidParameter type
stringrequired_without: uuidDefinition
Invoice order ID
You need to pass one of the required parameters, if you pass both, the account will be identified by order_id
Request example
curl https://api.heleket.com/v1/payment/aml-links \
-X POST \
-H 'merchant: 8b03432e-385b-4670-8d06-064591096795' \
-H 'sign: fe99035f86fa436181717b302b95bacff1' \
-H 'Content-Type: application/json' \
-d '{
"order_id": "order-42"
}'Response
Response parameters
| Name | Definition |
|---|---|
| link | Link to the AML questionnaire that is passed to the user |
| expired_at | Link expiration date and time in ISO 8601 (UTC) |
| status | Questionnaire completion status |
Definition
Link to the AML questionnaire that is passed to the userDefinition
Link expiration date and time in ISO 8601 (UTC)Definition
Questionnaire completion status
Link statuses
| Name | Definition |
|---|---|
| init | Link created, the questionnaire has not been started yet |
| pending | The questionnaire is in progress |
| completed | The questionnaire is completed |
| expired | The completion period has expired |
Definition
Link created, the questionnaire has not been started yetDefinition
The questionnaire is in progressDefinition
The questionnaire is completedDefinition
The completion period has expired
Response example
1{
2 "state": 0,
3 "result": [
4 {
5 "link": "https://some.link",
6 "expired_at": "2025-10-23T18:23:40.000000Z",
7 "status": "completed"
8 },
9 {
10 "link": "https://some.link",
11 "expired_at": "2026-05-13T11:32:38.000000Z",
12 "status": "init"
13 }
14 ]
15}