Submit originator data for Travel rule information request
Changed onSubmits originator information for a crypto payment that BVNK is holding under the Travel Rule after the customer has sent the payment.
Only use this endpoint to release payments held for missing Travel Rule information. This situation occurs when you request a payment below 3,000 currency units without Travel Rule details, but the customer sends a higher amount. BVNK will then hold the payment and send a bvnk:compliance:v1:information-request webhook requesting the required information.
To proceed, provide the requested information programmatically by passing the data.id from the webhook as externalId. Once accepted, the payment will resume processing.
To prevent this scenario, always include Travel Rule information when creating a payment, regardless of the amount. For more details, see Provide additional party information.
Held payments may be direct crypto deposits, channel transactions, or crypto payments (MPS), as indicated by data.relatedPayment.type in the webhook. These payments also appear in the Missing Contacts queue in the Portal, where you can assign an originator manually if preferred.
:::warning Entity-specific requirements The contact service has different externalId requirements based on entity type:
- INDIVIDUAL: externalId is required.
- COMPANY: externalId is optional. :::
Request
- Base URLhttps://api.sandbox.bvnk.com
- AuthAPI key in header Authorization
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
The ID of the information request to act on. Use the data.id value from the bvnk:compliance:v1:information-request webhook.
Request body
Example request
{
"type": "PROVIDE_INFORMATION",
"entity": {
"type": "INDIVIDUAL",
"externalId": "bd51c10c-fff8-4d38-a6ef-411371238caa",
"firstName": "John",
"lastName": "Doe",
"dateOfBirth": "08-11-1998",
"relationshipType": "THIRD_PARTY",
"address": {
"addressLine1": "10 Woodpecker",
"addressLine2": "Turf",
"city": "Cape Town",
"region": "Western Cape",
"postCode": "1234",
"country": "ZA"
}
}
}Response
Information accepted; the held payment will resume processing.
Changes
- breaking
the request property
/////became not nullable - breaking
the request property
/////became not nullable - breaking
the request property
/////became not nullable - breaking
the request property
/////became not nullable
- breaking
- info
endpoint added
- info