Account Verification Status Changed
Notification of a verification status change of a connected account.
Overview
Account Verification Status Changed is a Marketplace- and ISV-related webhook, which is triggered when the verification status of a connected account (such as a seller or merchant account) changes.
Webhook configuration
The below steps refer to Marketplace integrations. If you are instead setting up an ISV integration, please see our ISV Create webhook API call
This webhook is only available in the Production environment, not in the Demo environment
To enable in the Viva banking app:
Log in to Viva, demo or live , and select the required account.
Visit Settings > API Access > Webhooks.
Click on the Create Webhook link.
The New Webhook dialog box is displayed.Enter your webhook URL in the URL field.
Click on the Verify link.
If verified successfully, a confirmation message is displayed.Choose Account Verification Status Changed from the Event Type dropdown.
Select the Active checkbox to activate notifications.
Click on the Save button.
Response example
You may find below the sample response with EventTypeId
8194.
{
"Url": "Your webhook URL",
"EventData": {
"Verified":false,
"PersonId":"1aabc6f0-b419-4be5-b898-12345f4c912f",
"PlatformPersonId":"faa1a888-5651-4bdf-6565-4f41c730a321",
"ConnectedAccountId":"592d2e2f-11ec-408b-8552-ea06af1d1eee"
},
"Created": "2021-05-26T00:01:20.4752112Z",
"CorrelationId": "22-146-51FB37AA",
"EventTypeId": 8194,
"Delay": null,
"MessageId": "82606171-a5a3-4330-8a86-548b1111f451",
"RecipientId": "11ac9cd4-c9ea-48d3-b414-1f10ce999aad",
"MessageTypeId": 512
}
Webhook body
You can find below the body parameters of this webhook.
Parameter | Description | Example |
---|---|---|
Url (string) | Your webhook URL | "Your webhook URL" |
Verified (boolean) | Verification status | false |
PersonId (uuid) | The Id of the created person/merchant | "1aabc6f0-b419-4be5-b898-12345f4c912f" |
PlatformPersonId (uuid) | The Id of the platform/ISV account | "1aabc6f0-b419-4be5-b898-12345f4c912f" |
ConnectedAccountId (uuid) | The Id of the connected account (such as a seller or merchant account) | "592d2e2f-11ec-408b-8552-ea06af1d1eee" |
Created (datetime) | Transaction's creation timestamp | "2021-09-02T07:39:28.8496795Z" |
CorrelationId (uuid) | Internal Id to track the request flow for debug reasons | "21-245-DB33F8C9" |
EventTypeId (int) | The type of the event that triggered the notification | 8194 |
Delay (string) | Delay timespan for messages that are sent at a future date and not instantly | null |
MessageId (uuid) | Unique identifier of the message | "e8b09fc2-d4a4-43fc-8251-acd87ad04d96" |
RecipientId (uuid) | The recipient of the webhook | "bdf4c6b3-c26d-4046-b5df-5c443ec39d09" |
MessageTypeId (int) | The type of the message, this will always be webhook for the merchants 0x200 or 0x201 in hex. | 512 |
Get Support
If you would like to integrate with Viva, or if you have any queries about our products and solutions, please see our Contact & Support page to see how we can help!