Webhook Setup
For Liquidity Partners to communicate status updates with the Client during workflows like KYB/KYC, Onramp, and Offramp, the Client must furnish the API endpoint for webhook notifications. This specified endpoint will serve as the designated channel for all status updates. Additionally, the Client is required to share the endpoint for receiving webhooks on both the Sandbox and Production environments.
eventTypewill determine which workflow the status update belongs to.referenceIdwill allow Client to determine which object to connect the status update to. The reference ID is different depending on the eventType.metadatawill contain additional information to help Client process webhook notifications.
{
"referenceId": string, (transactionId for onramp,offramp. submissionId for kyc/kyb)
"eventType": string, (onramp, offramp, kyc, kyb)
"status": string,
"metadata": json,
}