Workflow Management
Send an Event
One entry point for every event type: onboarding, transaction and account_activity (login, card). Triggering events start evaluations; the rest are accepted and stored.
The request payloads documented here are for Transaction Monitoring (TM) events only (transaction and account_activity). There is no externalEntityId on the event itself: each entity identifies itself inside data. On a transaction, the sender and each beneficiary carry their own entityId (the Youverify platform’s id) or their own externalEntityId (your id) with a name and accountNumber; an account_activity event does the same at the root of data; an onboarding event carries data.externalEntityId (required) and data.entityId (when the workflow is for an existing entity). entityType (INDIVIDUAL or BUSINESS) is required inside data: at the root of data for account_activity and onboarding events, and on the sender and each beneficiary of a transaction. Send the entityId whenever you have it so the event is processed and enriched faster.
Routing. onboarding (CO) is routed by workflowId and workflowVersion. transaction and account_activity (TM) carry an eventCategory; a login carries data.loginMethod, and a card event carries data.cardAction (created or updated).
Triggering statuses. Only these start evaluations: transaction acknowledged, pending; login attempted; card requested, activated, pin_changed; and processing for any kind. Every other status (for example completed, successful, failed, issued, frozen, processed) is stored without a run.
Which workflows run. Every event runs the live TM workflows tagged with its eventCategory whose eventTypes includes its type (a TM workflow must list at least one to be saved or published). An account_activity event runs on { account_activity: data }. eventTypes decides which events start a workflow, not what it can read: any TM workflow can use the behavioural_insights.* variables, including those learned from account activity.
Validation and idempotency. data is validated per eventType. A transaction’s transactionReference is its idempotency key: a repeat of one already evaluated returns the original evaluations with replayed: true and runs nothing (its payload is ignored even if it differs); one with no live evaluation yet runs as normal.
Lifecycle. An event has a lifecycleId only if you send one; we never generate it. An event without one is connected to no other event and adds nothing to session-risk counters.
POST
/
v2
/
workflows
/
events
Send an Event
curl --request POST \
--url https://api.youverify.co/v2/workflows/events \
--header 'Content-Type: application/json' \
--header 'token: <api-key>' \
--data '
{
"eventType": "transaction",
"schemaVersion": "1.2",
"externalEventId": "string",
"eventStatus": "acknowledged",
"lifecycleId": "string",
"metadata": {
"source": "mobile-app"
},
"eventCategory": "finance",
"data": {
"paymentType": {
"direction": "OUTBOUND"
},
"financials": {
"totalAmount": 0,
"currency": "string"
},
"parties": {
"sender": {
"entityId": "string",
"entityType": "INDIVIDUAL",
"externalEntityId": "string",
"name": "string",
"accountNumber": "string",
"account": {
"balance": 0
},
"riskRating": "string",
"accountAge": 0,
"expectedMonthlyVolume": 0,
"accountStatus": "string",
"beneficialOwnerRiskTier": "string",
"productLimit": 0,
"internalBlacklistFlag": true
},
"beneficiaries": [
{
"entityId": "string",
"entityType": "INDIVIDUAL",
"externalEntityId": "string",
"name": "string",
"accountNumber": "string",
"account": {
"balance": 0
},
"riskRating": "string",
"accountAge": 0,
"expectedMonthlyVolume": 0,
"accountStatus": "string",
"beneficialOwnerRiskTier": "string",
"productLimit": 0,
"internalBlacklistFlag": true
}
]
},
"status": "string",
"settled_at": "2026-11-03T21:16:01.593Z",
"processed_at": "2026-11-03T21:16:01.593Z",
"fee_amount": 0,
"process_method": "string",
"is_approved": true,
"is_reversal": true,
"is_international_override": true,
"is_triggered_by_user": true,
"is_round_amount": true,
"is_large_transaction": true,
"counterparty": {
"industry": {
"code": "string"
},
"is_linked_account": true,
"is_new": true,
"age_days": 0,
"risk_tier": "string",
"is_watchlisted": true
},
"device": {
"is_proxy": true
},
"crypto": {
"asset_type": "string",
"wallet_address": "string",
"travel_rule_complete": true,
"mixer_exposure": true,
"sanctioned_address_exposure": true
},
"transactionReference": "string"
}
}
'import requests
url = "https://api.youverify.co/v2/workflows/events"
payload = {
"eventType": "transaction",
"schemaVersion": "1.2",
"externalEventId": "string",
"eventStatus": "acknowledged",
"lifecycleId": "string",
"metadata": { "source": "mobile-app" },
"eventCategory": "finance",
"data": {
"paymentType": { "direction": "OUTBOUND" },
"financials": {
"totalAmount": 0,
"currency": "string"
},
"parties": {
"sender": {
"entityId": "string",
"entityType": "INDIVIDUAL",
"externalEntityId": "string",
"name": "string",
"accountNumber": "string",
"account": { "balance": 0 },
"riskRating": "string",
"accountAge": 0,
"expectedMonthlyVolume": 0,
"accountStatus": "string",
"beneficialOwnerRiskTier": "string",
"productLimit": 0,
"internalBlacklistFlag": True
},
"beneficiaries": [
{
"entityId": "string",
"entityType": "INDIVIDUAL",
"externalEntityId": "string",
"name": "string",
"accountNumber": "string",
"account": { "balance": 0 },
"riskRating": "string",
"accountAge": 0,
"expectedMonthlyVolume": 0,
"accountStatus": "string",
"beneficialOwnerRiskTier": "string",
"productLimit": 0,
"internalBlacklistFlag": True
}
]
},
"status": "string",
"settled_at": "2026-11-03T21:16:01.593Z",
"processed_at": "2026-11-03T21:16:01.593Z",
"fee_amount": 0,
"process_method": "string",
"is_approved": True,
"is_reversal": True,
"is_international_override": True,
"is_triggered_by_user": True,
"is_round_amount": True,
"is_large_transaction": True,
"counterparty": {
"industry": { "code": "string" },
"is_linked_account": True,
"is_new": True,
"age_days": 0,
"risk_tier": "string",
"is_watchlisted": True
},
"device": { "is_proxy": True },
"crypto": {
"asset_type": "string",
"wallet_address": "string",
"travel_rule_complete": True,
"mixer_exposure": True,
"sanctioned_address_exposure": True
},
"transactionReference": "string"
}
}
headers = {
"token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
eventType: 'transaction',
schemaVersion: '1.2',
externalEventId: 'string',
eventStatus: 'acknowledged',
lifecycleId: 'string',
metadata: {source: 'mobile-app'},
eventCategory: 'finance',
data: {
paymentType: {direction: 'OUTBOUND'},
financials: {totalAmount: 0, currency: 'string'},
parties: {
sender: {
entityId: 'string',
entityType: 'INDIVIDUAL',
externalEntityId: 'string',
name: 'string',
accountNumber: 'string',
account: {balance: 0},
riskRating: 'string',
accountAge: 0,
expectedMonthlyVolume: 0,
accountStatus: 'string',
beneficialOwnerRiskTier: 'string',
productLimit: 0,
internalBlacklistFlag: true
},
beneficiaries: [
{
entityId: 'string',
entityType: 'INDIVIDUAL',
externalEntityId: 'string',
name: 'string',
accountNumber: 'string',
account: {balance: 0},
riskRating: 'string',
accountAge: 0,
expectedMonthlyVolume: 0,
accountStatus: 'string',
beneficialOwnerRiskTier: 'string',
productLimit: 0,
internalBlacklistFlag: true
}
]
},
status: 'string',
settled_at: '2026-11-03T21:16:01.593Z',
processed_at: '2026-11-03T21:16:01.593Z',
fee_amount: 0,
process_method: 'string',
is_approved: true,
is_reversal: true,
is_international_override: true,
is_triggered_by_user: true,
is_round_amount: true,
is_large_transaction: true,
counterparty: {
industry: {code: 'string'},
is_linked_account: true,
is_new: true,
age_days: 0,
risk_tier: 'string',
is_watchlisted: true
},
device: {is_proxy: true},
crypto: {
asset_type: 'string',
wallet_address: 'string',
travel_rule_complete: true,
mixer_exposure: true,
sanctioned_address_exposure: true
},
transactionReference: 'string'
}
})
};
fetch('https://api.youverify.co/v2/workflows/events', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.youverify.co/v2/workflows/events",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'eventType' => 'transaction',
'schemaVersion' => '1.2',
'externalEventId' => 'string',
'eventStatus' => 'acknowledged',
'lifecycleId' => 'string',
'metadata' => [
'source' => 'mobile-app'
],
'eventCategory' => 'finance',
'data' => [
'paymentType' => [
'direction' => 'OUTBOUND'
],
'financials' => [
'totalAmount' => 0,
'currency' => 'string'
],
'parties' => [
'sender' => [
'entityId' => 'string',
'entityType' => 'INDIVIDUAL',
'externalEntityId' => 'string',
'name' => 'string',
'accountNumber' => 'string',
'account' => [
'balance' => 0
],
'riskRating' => 'string',
'accountAge' => 0,
'expectedMonthlyVolume' => 0,
'accountStatus' => 'string',
'beneficialOwnerRiskTier' => 'string',
'productLimit' => 0,
'internalBlacklistFlag' => true
],
'beneficiaries' => [
[
'entityId' => 'string',
'entityType' => 'INDIVIDUAL',
'externalEntityId' => 'string',
'name' => 'string',
'accountNumber' => 'string',
'account' => [
'balance' => 0
],
'riskRating' => 'string',
'accountAge' => 0,
'expectedMonthlyVolume' => 0,
'accountStatus' => 'string',
'beneficialOwnerRiskTier' => 'string',
'productLimit' => 0,
'internalBlacklistFlag' => true
]
]
],
'status' => 'string',
'settled_at' => '2026-11-03T21:16:01.593Z',
'processed_at' => '2026-11-03T21:16:01.593Z',
'fee_amount' => 0,
'process_method' => 'string',
'is_approved' => true,
'is_reversal' => true,
'is_international_override' => true,
'is_triggered_by_user' => true,
'is_round_amount' => true,
'is_large_transaction' => true,
'counterparty' => [
'industry' => [
'code' => 'string'
],
'is_linked_account' => true,
'is_new' => true,
'age_days' => 0,
'risk_tier' => 'string',
'is_watchlisted' => true
],
'device' => [
'is_proxy' => true
],
'crypto' => [
'asset_type' => 'string',
'wallet_address' => 'string',
'travel_rule_complete' => true,
'mixer_exposure' => true,
'sanctioned_address_exposure' => true
],
'transactionReference' => 'string'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.youverify.co/v2/workflows/events"
payload := strings.NewReader("{\n \"eventType\": \"transaction\",\n \"schemaVersion\": \"1.2\",\n \"externalEventId\": \"string\",\n \"eventStatus\": \"acknowledged\",\n \"lifecycleId\": \"string\",\n \"metadata\": {\n \"source\": \"mobile-app\"\n },\n \"eventCategory\": \"finance\",\n \"data\": {\n \"paymentType\": {\n \"direction\": \"OUTBOUND\"\n },\n \"financials\": {\n \"totalAmount\": 0,\n \"currency\": \"string\"\n },\n \"parties\": {\n \"sender\": {\n \"entityId\": \"string\",\n \"entityType\": \"INDIVIDUAL\",\n \"externalEntityId\": \"string\",\n \"name\": \"string\",\n \"accountNumber\": \"string\",\n \"account\": {\n \"balance\": 0\n },\n \"riskRating\": \"string\",\n \"accountAge\": 0,\n \"expectedMonthlyVolume\": 0,\n \"accountStatus\": \"string\",\n \"beneficialOwnerRiskTier\": \"string\",\n \"productLimit\": 0,\n \"internalBlacklistFlag\": true\n },\n \"beneficiaries\": [\n {\n \"entityId\": \"string\",\n \"entityType\": \"INDIVIDUAL\",\n \"externalEntityId\": \"string\",\n \"name\": \"string\",\n \"accountNumber\": \"string\",\n \"account\": {\n \"balance\": 0\n },\n \"riskRating\": \"string\",\n \"accountAge\": 0,\n \"expectedMonthlyVolume\": 0,\n \"accountStatus\": \"string\",\n \"beneficialOwnerRiskTier\": \"string\",\n \"productLimit\": 0,\n \"internalBlacklistFlag\": true\n }\n ]\n },\n \"status\": \"string\",\n \"settled_at\": \"2026-11-03T21:16:01.593Z\",\n \"processed_at\": \"2026-11-03T21:16:01.593Z\",\n \"fee_amount\": 0,\n \"process_method\": \"string\",\n \"is_approved\": true,\n \"is_reversal\": true,\n \"is_international_override\": true,\n \"is_triggered_by_user\": true,\n \"is_round_amount\": true,\n \"is_large_transaction\": true,\n \"counterparty\": {\n \"industry\": {\n \"code\": \"string\"\n },\n \"is_linked_account\": true,\n \"is_new\": true,\n \"age_days\": 0,\n \"risk_tier\": \"string\",\n \"is_watchlisted\": true\n },\n \"device\": {\n \"is_proxy\": true\n },\n \"crypto\": {\n \"asset_type\": \"string\",\n \"wallet_address\": \"string\",\n \"travel_rule_complete\": true,\n \"mixer_exposure\": true,\n \"sanctioned_address_exposure\": true\n },\n \"transactionReference\": \"string\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.youverify.co/v2/workflows/events")
.header("token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"eventType\": \"transaction\",\n \"schemaVersion\": \"1.2\",\n \"externalEventId\": \"string\",\n \"eventStatus\": \"acknowledged\",\n \"lifecycleId\": \"string\",\n \"metadata\": {\n \"source\": \"mobile-app\"\n },\n \"eventCategory\": \"finance\",\n \"data\": {\n \"paymentType\": {\n \"direction\": \"OUTBOUND\"\n },\n \"financials\": {\n \"totalAmount\": 0,\n \"currency\": \"string\"\n },\n \"parties\": {\n \"sender\": {\n \"entityId\": \"string\",\n \"entityType\": \"INDIVIDUAL\",\n \"externalEntityId\": \"string\",\n \"name\": \"string\",\n \"accountNumber\": \"string\",\n \"account\": {\n \"balance\": 0\n },\n \"riskRating\": \"string\",\n \"accountAge\": 0,\n \"expectedMonthlyVolume\": 0,\n \"accountStatus\": \"string\",\n \"beneficialOwnerRiskTier\": \"string\",\n \"productLimit\": 0,\n \"internalBlacklistFlag\": true\n },\n \"beneficiaries\": [\n {\n \"entityId\": \"string\",\n \"entityType\": \"INDIVIDUAL\",\n \"externalEntityId\": \"string\",\n \"name\": \"string\",\n \"accountNumber\": \"string\",\n \"account\": {\n \"balance\": 0\n },\n \"riskRating\": \"string\",\n \"accountAge\": 0,\n \"expectedMonthlyVolume\": 0,\n \"accountStatus\": \"string\",\n \"beneficialOwnerRiskTier\": \"string\",\n \"productLimit\": 0,\n \"internalBlacklistFlag\": true\n }\n ]\n },\n \"status\": \"string\",\n \"settled_at\": \"2026-11-03T21:16:01.593Z\",\n \"processed_at\": \"2026-11-03T21:16:01.593Z\",\n \"fee_amount\": 0,\n \"process_method\": \"string\",\n \"is_approved\": true,\n \"is_reversal\": true,\n \"is_international_override\": true,\n \"is_triggered_by_user\": true,\n \"is_round_amount\": true,\n \"is_large_transaction\": true,\n \"counterparty\": {\n \"industry\": {\n \"code\": \"string\"\n },\n \"is_linked_account\": true,\n \"is_new\": true,\n \"age_days\": 0,\n \"risk_tier\": \"string\",\n \"is_watchlisted\": true\n },\n \"device\": {\n \"is_proxy\": true\n },\n \"crypto\": {\n \"asset_type\": \"string\",\n \"wallet_address\": \"string\",\n \"travel_rule_complete\": true,\n \"mixer_exposure\": true,\n \"sanctioned_address_exposure\": true\n },\n \"transactionReference\": \"string\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.youverify.co/v2/workflows/events")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"eventType\": \"transaction\",\n \"schemaVersion\": \"1.2\",\n \"externalEventId\": \"string\",\n \"eventStatus\": \"acknowledged\",\n \"lifecycleId\": \"string\",\n \"metadata\": {\n \"source\": \"mobile-app\"\n },\n \"eventCategory\": \"finance\",\n \"data\": {\n \"paymentType\": {\n \"direction\": \"OUTBOUND\"\n },\n \"financials\": {\n \"totalAmount\": 0,\n \"currency\": \"string\"\n },\n \"parties\": {\n \"sender\": {\n \"entityId\": \"string\",\n \"entityType\": \"INDIVIDUAL\",\n \"externalEntityId\": \"string\",\n \"name\": \"string\",\n \"accountNumber\": \"string\",\n \"account\": {\n \"balance\": 0\n },\n \"riskRating\": \"string\",\n \"accountAge\": 0,\n \"expectedMonthlyVolume\": 0,\n \"accountStatus\": \"string\",\n \"beneficialOwnerRiskTier\": \"string\",\n \"productLimit\": 0,\n \"internalBlacklistFlag\": true\n },\n \"beneficiaries\": [\n {\n \"entityId\": \"string\",\n \"entityType\": \"INDIVIDUAL\",\n \"externalEntityId\": \"string\",\n \"name\": \"string\",\n \"accountNumber\": \"string\",\n \"account\": {\n \"balance\": 0\n },\n \"riskRating\": \"string\",\n \"accountAge\": 0,\n \"expectedMonthlyVolume\": 0,\n \"accountStatus\": \"string\",\n \"beneficialOwnerRiskTier\": \"string\",\n \"productLimit\": 0,\n \"internalBlacklistFlag\": true\n }\n ]\n },\n \"status\": \"string\",\n \"settled_at\": \"2026-11-03T21:16:01.593Z\",\n \"processed_at\": \"2026-11-03T21:16:01.593Z\",\n \"fee_amount\": 0,\n \"process_method\": \"string\",\n \"is_approved\": true,\n \"is_reversal\": true,\n \"is_international_override\": true,\n \"is_triggered_by_user\": true,\n \"is_round_amount\": true,\n \"is_large_transaction\": true,\n \"counterparty\": {\n \"industry\": {\n \"code\": \"string\"\n },\n \"is_linked_account\": true,\n \"is_new\": true,\n \"age_days\": 0,\n \"risk_tier\": \"string\",\n \"is_watchlisted\": true\n },\n \"device\": {\n \"is_proxy\": true\n },\n \"crypto\": {\n \"asset_type\": \"string\",\n \"wallet_address\": \"string\",\n \"travel_rule_complete\": true,\n \"mixer_exposure\": true,\n \"sanctioned_address_exposure\": true\n },\n \"transactionReference\": \"string\"\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"statusCode": 202,
"message": "Event accepted",
"data": {
"evaluations": [
{
"id": "string",
"status": "PENDING",
"decision": "BLOCK",
"decisionReason": "string",
"decisionFinal": true,
"riskScore": 0,
"actionsApplied": [
"string"
],
"outcome": {
"result": "approved",
"flagged": [
"string"
]
},
"entityId": "string",
"entityName": "string"
}
],
"count": 0,
"replayed": true
},
"links": [
{}
]
}{
"success": false,
"statusCode": 401,
"message": "Permission denied",
"name": "UnauthorizedError",
"data": {}
}{
"success": false,
"statusCode": 429,
"message": "Too many requests",
"name": "RateLimitError",
"data": {}
}{
"success": false,
"statusCode": 500,
"message": "Internal Server Error",
"name": "Error",
"data": {}
}Authorizations
Your Youverify API secret key. Never expose client-side.
Headers
API secret token
Body
application/json
Type of event.
Available options:
transaction, account_activity, onboarding Status of the event. Only triggering statuses start evaluations; others are stored without a run.
Available options:
acknowledged, pending, completed, attempted, successful, requested, issued, activated, frozen, suspended, unfrozen, pin_changed, closed, canceled, failed Event payload, validated per eventType. Fields below are for a transaction event.
Show child attributes
Show child attributes
Version of the event schema.
Example:
"1.2"
Your own identifier for the event.
Optional id that connects related events. We never generate it; events without one are connected to no other event.
Free-form metadata about the event.
Show child attributes
Show child attributes
Category used to select the live TM workflows to run (for transaction and account_activity events).
Example:
"finance"
⌘I
Send an Event
curl --request POST \
--url https://api.youverify.co/v2/workflows/events \
--header 'Content-Type: application/json' \
--header 'token: <api-key>' \
--data '
{
"eventType": "transaction",
"schemaVersion": "1.2",
"externalEventId": "string",
"eventStatus": "acknowledged",
"lifecycleId": "string",
"metadata": {
"source": "mobile-app"
},
"eventCategory": "finance",
"data": {
"paymentType": {
"direction": "OUTBOUND"
},
"financials": {
"totalAmount": 0,
"currency": "string"
},
"parties": {
"sender": {
"entityId": "string",
"entityType": "INDIVIDUAL",
"externalEntityId": "string",
"name": "string",
"accountNumber": "string",
"account": {
"balance": 0
},
"riskRating": "string",
"accountAge": 0,
"expectedMonthlyVolume": 0,
"accountStatus": "string",
"beneficialOwnerRiskTier": "string",
"productLimit": 0,
"internalBlacklistFlag": true
},
"beneficiaries": [
{
"entityId": "string",
"entityType": "INDIVIDUAL",
"externalEntityId": "string",
"name": "string",
"accountNumber": "string",
"account": {
"balance": 0
},
"riskRating": "string",
"accountAge": 0,
"expectedMonthlyVolume": 0,
"accountStatus": "string",
"beneficialOwnerRiskTier": "string",
"productLimit": 0,
"internalBlacklistFlag": true
}
]
},
"status": "string",
"settled_at": "2026-11-03T21:16:01.593Z",
"processed_at": "2026-11-03T21:16:01.593Z",
"fee_amount": 0,
"process_method": "string",
"is_approved": true,
"is_reversal": true,
"is_international_override": true,
"is_triggered_by_user": true,
"is_round_amount": true,
"is_large_transaction": true,
"counterparty": {
"industry": {
"code": "string"
},
"is_linked_account": true,
"is_new": true,
"age_days": 0,
"risk_tier": "string",
"is_watchlisted": true
},
"device": {
"is_proxy": true
},
"crypto": {
"asset_type": "string",
"wallet_address": "string",
"travel_rule_complete": true,
"mixer_exposure": true,
"sanctioned_address_exposure": true
},
"transactionReference": "string"
}
}
'import requests
url = "https://api.youverify.co/v2/workflows/events"
payload = {
"eventType": "transaction",
"schemaVersion": "1.2",
"externalEventId": "string",
"eventStatus": "acknowledged",
"lifecycleId": "string",
"metadata": { "source": "mobile-app" },
"eventCategory": "finance",
"data": {
"paymentType": { "direction": "OUTBOUND" },
"financials": {
"totalAmount": 0,
"currency": "string"
},
"parties": {
"sender": {
"entityId": "string",
"entityType": "INDIVIDUAL",
"externalEntityId": "string",
"name": "string",
"accountNumber": "string",
"account": { "balance": 0 },
"riskRating": "string",
"accountAge": 0,
"expectedMonthlyVolume": 0,
"accountStatus": "string",
"beneficialOwnerRiskTier": "string",
"productLimit": 0,
"internalBlacklistFlag": True
},
"beneficiaries": [
{
"entityId": "string",
"entityType": "INDIVIDUAL",
"externalEntityId": "string",
"name": "string",
"accountNumber": "string",
"account": { "balance": 0 },
"riskRating": "string",
"accountAge": 0,
"expectedMonthlyVolume": 0,
"accountStatus": "string",
"beneficialOwnerRiskTier": "string",
"productLimit": 0,
"internalBlacklistFlag": True
}
]
},
"status": "string",
"settled_at": "2026-11-03T21:16:01.593Z",
"processed_at": "2026-11-03T21:16:01.593Z",
"fee_amount": 0,
"process_method": "string",
"is_approved": True,
"is_reversal": True,
"is_international_override": True,
"is_triggered_by_user": True,
"is_round_amount": True,
"is_large_transaction": True,
"counterparty": {
"industry": { "code": "string" },
"is_linked_account": True,
"is_new": True,
"age_days": 0,
"risk_tier": "string",
"is_watchlisted": True
},
"device": { "is_proxy": True },
"crypto": {
"asset_type": "string",
"wallet_address": "string",
"travel_rule_complete": True,
"mixer_exposure": True,
"sanctioned_address_exposure": True
},
"transactionReference": "string"
}
}
headers = {
"token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
eventType: 'transaction',
schemaVersion: '1.2',
externalEventId: 'string',
eventStatus: 'acknowledged',
lifecycleId: 'string',
metadata: {source: 'mobile-app'},
eventCategory: 'finance',
data: {
paymentType: {direction: 'OUTBOUND'},
financials: {totalAmount: 0, currency: 'string'},
parties: {
sender: {
entityId: 'string',
entityType: 'INDIVIDUAL',
externalEntityId: 'string',
name: 'string',
accountNumber: 'string',
account: {balance: 0},
riskRating: 'string',
accountAge: 0,
expectedMonthlyVolume: 0,
accountStatus: 'string',
beneficialOwnerRiskTier: 'string',
productLimit: 0,
internalBlacklistFlag: true
},
beneficiaries: [
{
entityId: 'string',
entityType: 'INDIVIDUAL',
externalEntityId: 'string',
name: 'string',
accountNumber: 'string',
account: {balance: 0},
riskRating: 'string',
accountAge: 0,
expectedMonthlyVolume: 0,
accountStatus: 'string',
beneficialOwnerRiskTier: 'string',
productLimit: 0,
internalBlacklistFlag: true
}
]
},
status: 'string',
settled_at: '2026-11-03T21:16:01.593Z',
processed_at: '2026-11-03T21:16:01.593Z',
fee_amount: 0,
process_method: 'string',
is_approved: true,
is_reversal: true,
is_international_override: true,
is_triggered_by_user: true,
is_round_amount: true,
is_large_transaction: true,
counterparty: {
industry: {code: 'string'},
is_linked_account: true,
is_new: true,
age_days: 0,
risk_tier: 'string',
is_watchlisted: true
},
device: {is_proxy: true},
crypto: {
asset_type: 'string',
wallet_address: 'string',
travel_rule_complete: true,
mixer_exposure: true,
sanctioned_address_exposure: true
},
transactionReference: 'string'
}
})
};
fetch('https://api.youverify.co/v2/workflows/events', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.youverify.co/v2/workflows/events",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'eventType' => 'transaction',
'schemaVersion' => '1.2',
'externalEventId' => 'string',
'eventStatus' => 'acknowledged',
'lifecycleId' => 'string',
'metadata' => [
'source' => 'mobile-app'
],
'eventCategory' => 'finance',
'data' => [
'paymentType' => [
'direction' => 'OUTBOUND'
],
'financials' => [
'totalAmount' => 0,
'currency' => 'string'
],
'parties' => [
'sender' => [
'entityId' => 'string',
'entityType' => 'INDIVIDUAL',
'externalEntityId' => 'string',
'name' => 'string',
'accountNumber' => 'string',
'account' => [
'balance' => 0
],
'riskRating' => 'string',
'accountAge' => 0,
'expectedMonthlyVolume' => 0,
'accountStatus' => 'string',
'beneficialOwnerRiskTier' => 'string',
'productLimit' => 0,
'internalBlacklistFlag' => true
],
'beneficiaries' => [
[
'entityId' => 'string',
'entityType' => 'INDIVIDUAL',
'externalEntityId' => 'string',
'name' => 'string',
'accountNumber' => 'string',
'account' => [
'balance' => 0
],
'riskRating' => 'string',
'accountAge' => 0,
'expectedMonthlyVolume' => 0,
'accountStatus' => 'string',
'beneficialOwnerRiskTier' => 'string',
'productLimit' => 0,
'internalBlacklistFlag' => true
]
]
],
'status' => 'string',
'settled_at' => '2026-11-03T21:16:01.593Z',
'processed_at' => '2026-11-03T21:16:01.593Z',
'fee_amount' => 0,
'process_method' => 'string',
'is_approved' => true,
'is_reversal' => true,
'is_international_override' => true,
'is_triggered_by_user' => true,
'is_round_amount' => true,
'is_large_transaction' => true,
'counterparty' => [
'industry' => [
'code' => 'string'
],
'is_linked_account' => true,
'is_new' => true,
'age_days' => 0,
'risk_tier' => 'string',
'is_watchlisted' => true
],
'device' => [
'is_proxy' => true
],
'crypto' => [
'asset_type' => 'string',
'wallet_address' => 'string',
'travel_rule_complete' => true,
'mixer_exposure' => true,
'sanctioned_address_exposure' => true
],
'transactionReference' => 'string'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.youverify.co/v2/workflows/events"
payload := strings.NewReader("{\n \"eventType\": \"transaction\",\n \"schemaVersion\": \"1.2\",\n \"externalEventId\": \"string\",\n \"eventStatus\": \"acknowledged\",\n \"lifecycleId\": \"string\",\n \"metadata\": {\n \"source\": \"mobile-app\"\n },\n \"eventCategory\": \"finance\",\n \"data\": {\n \"paymentType\": {\n \"direction\": \"OUTBOUND\"\n },\n \"financials\": {\n \"totalAmount\": 0,\n \"currency\": \"string\"\n },\n \"parties\": {\n \"sender\": {\n \"entityId\": \"string\",\n \"entityType\": \"INDIVIDUAL\",\n \"externalEntityId\": \"string\",\n \"name\": \"string\",\n \"accountNumber\": \"string\",\n \"account\": {\n \"balance\": 0\n },\n \"riskRating\": \"string\",\n \"accountAge\": 0,\n \"expectedMonthlyVolume\": 0,\n \"accountStatus\": \"string\",\n \"beneficialOwnerRiskTier\": \"string\",\n \"productLimit\": 0,\n \"internalBlacklistFlag\": true\n },\n \"beneficiaries\": [\n {\n \"entityId\": \"string\",\n \"entityType\": \"INDIVIDUAL\",\n \"externalEntityId\": \"string\",\n \"name\": \"string\",\n \"accountNumber\": \"string\",\n \"account\": {\n \"balance\": 0\n },\n \"riskRating\": \"string\",\n \"accountAge\": 0,\n \"expectedMonthlyVolume\": 0,\n \"accountStatus\": \"string\",\n \"beneficialOwnerRiskTier\": \"string\",\n \"productLimit\": 0,\n \"internalBlacklistFlag\": true\n }\n ]\n },\n \"status\": \"string\",\n \"settled_at\": \"2026-11-03T21:16:01.593Z\",\n \"processed_at\": \"2026-11-03T21:16:01.593Z\",\n \"fee_amount\": 0,\n \"process_method\": \"string\",\n \"is_approved\": true,\n \"is_reversal\": true,\n \"is_international_override\": true,\n \"is_triggered_by_user\": true,\n \"is_round_amount\": true,\n \"is_large_transaction\": true,\n \"counterparty\": {\n \"industry\": {\n \"code\": \"string\"\n },\n \"is_linked_account\": true,\n \"is_new\": true,\n \"age_days\": 0,\n \"risk_tier\": \"string\",\n \"is_watchlisted\": true\n },\n \"device\": {\n \"is_proxy\": true\n },\n \"crypto\": {\n \"asset_type\": \"string\",\n \"wallet_address\": \"string\",\n \"travel_rule_complete\": true,\n \"mixer_exposure\": true,\n \"sanctioned_address_exposure\": true\n },\n \"transactionReference\": \"string\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.youverify.co/v2/workflows/events")
.header("token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"eventType\": \"transaction\",\n \"schemaVersion\": \"1.2\",\n \"externalEventId\": \"string\",\n \"eventStatus\": \"acknowledged\",\n \"lifecycleId\": \"string\",\n \"metadata\": {\n \"source\": \"mobile-app\"\n },\n \"eventCategory\": \"finance\",\n \"data\": {\n \"paymentType\": {\n \"direction\": \"OUTBOUND\"\n },\n \"financials\": {\n \"totalAmount\": 0,\n \"currency\": \"string\"\n },\n \"parties\": {\n \"sender\": {\n \"entityId\": \"string\",\n \"entityType\": \"INDIVIDUAL\",\n \"externalEntityId\": \"string\",\n \"name\": \"string\",\n \"accountNumber\": \"string\",\n \"account\": {\n \"balance\": 0\n },\n \"riskRating\": \"string\",\n \"accountAge\": 0,\n \"expectedMonthlyVolume\": 0,\n \"accountStatus\": \"string\",\n \"beneficialOwnerRiskTier\": \"string\",\n \"productLimit\": 0,\n \"internalBlacklistFlag\": true\n },\n \"beneficiaries\": [\n {\n \"entityId\": \"string\",\n \"entityType\": \"INDIVIDUAL\",\n \"externalEntityId\": \"string\",\n \"name\": \"string\",\n \"accountNumber\": \"string\",\n \"account\": {\n \"balance\": 0\n },\n \"riskRating\": \"string\",\n \"accountAge\": 0,\n \"expectedMonthlyVolume\": 0,\n \"accountStatus\": \"string\",\n \"beneficialOwnerRiskTier\": \"string\",\n \"productLimit\": 0,\n \"internalBlacklistFlag\": true\n }\n ]\n },\n \"status\": \"string\",\n \"settled_at\": \"2026-11-03T21:16:01.593Z\",\n \"processed_at\": \"2026-11-03T21:16:01.593Z\",\n \"fee_amount\": 0,\n \"process_method\": \"string\",\n \"is_approved\": true,\n \"is_reversal\": true,\n \"is_international_override\": true,\n \"is_triggered_by_user\": true,\n \"is_round_amount\": true,\n \"is_large_transaction\": true,\n \"counterparty\": {\n \"industry\": {\n \"code\": \"string\"\n },\n \"is_linked_account\": true,\n \"is_new\": true,\n \"age_days\": 0,\n \"risk_tier\": \"string\",\n \"is_watchlisted\": true\n },\n \"device\": {\n \"is_proxy\": true\n },\n \"crypto\": {\n \"asset_type\": \"string\",\n \"wallet_address\": \"string\",\n \"travel_rule_complete\": true,\n \"mixer_exposure\": true,\n \"sanctioned_address_exposure\": true\n },\n \"transactionReference\": \"string\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.youverify.co/v2/workflows/events")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"eventType\": \"transaction\",\n \"schemaVersion\": \"1.2\",\n \"externalEventId\": \"string\",\n \"eventStatus\": \"acknowledged\",\n \"lifecycleId\": \"string\",\n \"metadata\": {\n \"source\": \"mobile-app\"\n },\n \"eventCategory\": \"finance\",\n \"data\": {\n \"paymentType\": {\n \"direction\": \"OUTBOUND\"\n },\n \"financials\": {\n \"totalAmount\": 0,\n \"currency\": \"string\"\n },\n \"parties\": {\n \"sender\": {\n \"entityId\": \"string\",\n \"entityType\": \"INDIVIDUAL\",\n \"externalEntityId\": \"string\",\n \"name\": \"string\",\n \"accountNumber\": \"string\",\n \"account\": {\n \"balance\": 0\n },\n \"riskRating\": \"string\",\n \"accountAge\": 0,\n \"expectedMonthlyVolume\": 0,\n \"accountStatus\": \"string\",\n \"beneficialOwnerRiskTier\": \"string\",\n \"productLimit\": 0,\n \"internalBlacklistFlag\": true\n },\n \"beneficiaries\": [\n {\n \"entityId\": \"string\",\n \"entityType\": \"INDIVIDUAL\",\n \"externalEntityId\": \"string\",\n \"name\": \"string\",\n \"accountNumber\": \"string\",\n \"account\": {\n \"balance\": 0\n },\n \"riskRating\": \"string\",\n \"accountAge\": 0,\n \"expectedMonthlyVolume\": 0,\n \"accountStatus\": \"string\",\n \"beneficialOwnerRiskTier\": \"string\",\n \"productLimit\": 0,\n \"internalBlacklistFlag\": true\n }\n ]\n },\n \"status\": \"string\",\n \"settled_at\": \"2026-11-03T21:16:01.593Z\",\n \"processed_at\": \"2026-11-03T21:16:01.593Z\",\n \"fee_amount\": 0,\n \"process_method\": \"string\",\n \"is_approved\": true,\n \"is_reversal\": true,\n \"is_international_override\": true,\n \"is_triggered_by_user\": true,\n \"is_round_amount\": true,\n \"is_large_transaction\": true,\n \"counterparty\": {\n \"industry\": {\n \"code\": \"string\"\n },\n \"is_linked_account\": true,\n \"is_new\": true,\n \"age_days\": 0,\n \"risk_tier\": \"string\",\n \"is_watchlisted\": true\n },\n \"device\": {\n \"is_proxy\": true\n },\n \"crypto\": {\n \"asset_type\": \"string\",\n \"wallet_address\": \"string\",\n \"travel_rule_complete\": true,\n \"mixer_exposure\": true,\n \"sanctioned_address_exposure\": true\n },\n \"transactionReference\": \"string\"\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"statusCode": 202,
"message": "Event accepted",
"data": {
"evaluations": [
{
"id": "string",
"status": "PENDING",
"decision": "BLOCK",
"decisionReason": "string",
"decisionFinal": true,
"riskScore": 0,
"actionsApplied": [
"string"
],
"outcome": {
"result": "approved",
"flagged": [
"string"
]
},
"entityId": "string",
"entityName": "string"
}
],
"count": 0,
"replayed": true
},
"links": [
{}
]
}{
"success": false,
"statusCode": 401,
"message": "Permission denied",
"name": "UnauthorizedError",
"data": {}
}{
"success": false,
"statusCode": 429,
"message": "Too many requests",
"name": "RateLimitError",
"data": {}
}{
"success": false,
"statusCode": 500,
"message": "Internal Server Error",
"name": "Error",
"data": {}
}