Entity approval status specific events
| Event | Description | Default |
|---|---|---|
entity.approval_processing | Triggered when the entity approval status is processing | On |
entity.approval_requires_action | Triggered when the entity approval status is requires_action | On |
entity.approval_succeeded | Triggered when the entity approval status is succeeded | On |
entity.approval_rejected | Triggered when the entity approval status is rejected | On |
Sample Events
entity.approval_processing
{
"created_at": "2026-02-17T12:39:43.901330356Z",
"data": {
"approval_status": "submitted",
"approval_status_description": "The KYB process is under review.",
"created_at": "2026-01-23T11:22:27.085281Z",
"documents": [
{
"description": "Personal Proof of Identity",
"document_id": "doc_d5pljss1bo7of7h5u5e0",
"file_name": "kyb_doc34354_23January2026_1769167330074003661_Test.pdf",
"sub_type": "passport",
"tag": "identityProofTypeFrontDoc",
"type": "identity",
"updated_at": "2026-01-23T11:22:27.096517Z",
"url": "https://s3.ap-southeast-1.amazonaws.com/tazapay-onboarding-service/kyb_d5pljss1bo7of7h5u5c0/kyb_doc34354_23January2026_1769167330074003661_Test.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Checksum-Mode="
},
{
"document_id": "doc_d6a63398ddembfa2eqd0",
"file_name": "kyb_doc38635_17February2026_Invoice",
"sub_type": "other",
"tag": "requestedDoc",
"type": "other",
"updated_at": "2026-02-17T12:39:41.51072Z",
"url": "https://s3.ap-southeast-1.amazonaws.com/tazapay-onboarding-service/kyb_d5pljss1bo7of7h5u5c0/kyb_doc38635_17February2026_Invoice?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Checksum-Mode=ENABLED&X-Amz-Credential"
}
],
"email": "user@example.com",
"id": "ent_d5pljspj18o8ibogsjmg",
"individual": {
"date_of_birth": "1990-05-15",
"national_identification_number": {
"type": "passport",
"number": "P1234567",
"issuer": {
"country": "SG",
"state": ""
},
"expiration": "2030-05-14",
"country_of_citizenship": "SG"
},
"nationality": "SG",
"profession": {
"occupation": "Software Engineer",
"isco_code": "2512",
"industry": "Technology",
"employment_status": "employed"
},
"source_of_funds": {
"primary_source": "salary",
"description": ""
},
"employment_details": {
"employer_name": "Acme Corp",
"designation": "Senior Engineer"
}
},
"transaction_profile": {
"monthly_expected_transactions_value": 10000,
"monthly_expected_transaction_volume": 5,
"expected_transaction_countries": ["SG", "US"],
"expected_transaction_currencies": ["USD", "SGD"],
"customer_risk": "low"
},
"name": "JOHN WONG",
"object": "entity",
"pending_documents": [
"Invoice"
],
"phone": {},
"purpose_of_use": [
"collect",
"payout"
],
"reference_id": "A1000003",
"registration_address": {
"city": "SG",
"country": "SG",
"line1": "123 Street 3/5",
"line2": "",
"postal_code": "123123",
"state": "SG"
},
"relationship": "customer",
"submit": true,
"submitted_at": "2026-01-23T11:22:27.101462Z",
"type": "individual"
},
"id": "evt_d6a633obm14biavhciig",
"object": "event",
"type": "entity.approval_processing"
}
entity.approval_requires_action
{
"created_at": "2026-02-18T06:47:36.485931431Z",
"data": {
"approval_status": "requires_action",
"approval_status_description": "Upload the doc",
"created_at": "2026-02-17T05:52:28.992314Z",
"documents": [
{
"document_id": "doc_d6a0udrgbjuth19tnvsg",
"file_name": "kyb_doc51787_17February2026_Invoice",
"sub_type": "other",
"tag": "additionalDoc",
"type": "other",
"updated_at": "2026-02-17T06:48:23.509145Z",
"url": "https://s3.ap-southeast-1.amazonaws.com/tazapay-onboarding-service/kyb_d6a04798ddembfa2e50g/kyb_doc51787_17February2026_Invoice?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Checksum-Mode=ENABLED&X-Amz-Credential=ASIAUGJYD3OSYWCDJB4N%2F20260218%2Fap-southeast-1%2Fs3%2Faws4_request&X-Amz-Date=20260218T064736Z&X-Amz-Expires=3600&X-Amz-Security-Token="
},
{
"document_id": "doc_d6a64vh8ddembfa2eqm0",
"file_name": "kyb_doc51241_17February2026_Invoice",
"sub_type": "other",
"tag": "requestedDoc",
"type": "other",
"updated_at": "2026-02-17T12:43:42.642691Z",
"url": "https://s3.ap-southeast-1.amazonaws.com/tazapay-onboarding-service/kyb_d6a04798ddembfa2e50g/kyb_doc51241_17February2026_Invoice?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Checksum-Mode=ENABLED&X-Amz-Credential=ASIAUGJYD3OSYWCDJB4N%2F20260218%2Fap-southeast-1%2Fs3%2Faws4_request&X-Amz-Date=20260218T064736Z&X-Amz-Expires=3600&X-Amz-Security-Token="
}
],
"email": "",
"id": "ent_d6a0475jd0fvsnsige9g",
"name": "Dhanutestentity",
"object": "entity",
"operating_address": {
"city": "Chennai",
"country": "AO",
"line1": "124",
"line2": "134",
"postal_code": "621216",
"state": "3243"
},
"pending_documents": [
"Invoice"
],
"purpose_of_use": [
"payout"
],
"reference_id": "ent_d6a0475jd0fvsnsige9g",
"registration_address": {
"city": "Chennai",
"country": "AO",
"line1": "124",
"line2": "134",
"postal_code": "621216",
"state": "3243"
},
"registration_number": "1324345",
"relationship": "customer",
"submit": true,
"submitted_at": "2026-02-17T05:52:32.236083Z",
"type": "company",
"vertical": "Digital Products-Apps, eBooks, Blogs & Games"
},
"id": "evt_d6am120bm14biavobg90",
"object": "event",
"type": "entity.approval_requires_action"
}
entity.approval_succeeded
{
"created_at": "2026-02-18T10:24:09.274176008Z",
"data": {
"approval_status": "approved",
"approval_status_description": "Approved",
"approved_at": "2026-02-18T10:24:06.791763Z",
"created_at": "2026-02-17T05:52:28.992314Z",
"documents": [
{
"document_id": "doc_d6a0udrgbjuth19tnvsg",
"file_name": "kyb_doc51787_17February2026_Invoice",
"sub_type": "other",
"tag": "additionalDoc",
"type": "other",
"updated_at": "2026-02-17T06:48:23.509145Z",
"url": "https://s3.ap-southeast-1.amazonaws.com/tazapay-onboarding-service/kyb_d6a04798ddembfa2e50g/kyb_doc51787_17February2026_Invoice?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Checksum-Mode=ENABLED&X-Amz-Credential=ASIAUGJYD3OSSZXQQ2WF%2F20260218%2Fap-southeast-1%2Fs3%2Faws4_request&X-Amz-Date=20260218T102409Z&X-Amz-Expires=3600&X-Amz-Security-Token"
},
{
"document_id": "doc_d6a64vh8ddembfa2eqm0",
"file_name": "kyb_doc51241_17February2026_Invoice",
"sub_type": "other",
"tag": "requestedDoc",
"type": "other",
"updated_at": "2026-02-18T10:24:06.791763Z",
"url": "https://s3.ap-southeast-1.amazonaws.com/tazapay-onboarding-service/kyb_d6a04798ddembfa2e50g/kyb_doc51241_17February2026_Invoice?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Checksum-Mode=ENABLED&X-Amz-Credential=ASIAUGJYD3OSSZXQQ2WF%2F20260218%2Fap-southeast-1%2Fs3%2Faws4_request&X-Amz-Date=20260218T102409Z&X-Amz-Expires=3600&X-Amz-Security-Token"
}
],
"email": "",
"id": "ent_d6a0475jd0fvsnsige9g",
"name": "Dhanutestentity",
"object": "entity",
"operating_address": {
"city": "Chennai",
"country": "AO",
"line1": "124",
"line2": "134",
"postal_code": "621216",
"state": "3243"
},
"pending_documents": [
"Invoice"
],
"purpose_of_use": [
"payout"
],
"reference_id": "ent_d6a0475jd0fvsnsige9g",
"registration_address": {
"city": "Chennai",
"country": "AO",
"line1": "124",
"line2": "134",
"postal_code": "621216",
"state": "3243"
},
"registration_number": "1324345",
"relationship": "customer",
"submit": true,
"submitted_at": "2026-02-17T05:52:32.236083Z",
"type": "company",
"vertical": "Digital Products-Apps, eBooks, Blogs & Games"
},
"id": "evt_d6ap6i8837kbtle7pk2g",
"object": "event",
"type": "entity.approval_succeeded"
}
entity.approval_rejected
{
"created_at": "2026-02-06T08:34:15.760954054Z",
"data": {
"approval_status": "rejected",
"approval_status_description": "Rejected as documents are invalid",
"created_at": "2026-01-23T11:33:32.042822Z",
"documents": [
{
"description": "Personal Proof of Identity",
"document_id": "doc_d5plp341bo7of7h5u6a0",
"file_name": "kyb_doc61151_23January2026_1test_.pdf",
"sub_type": "passport",
"tag": "identityProofTypeFrontDoc",
"type": "identity",
"updated_at": "2026-01-23T11:33:32.054037Z"
}
],
"email": "user@example.com",
"id": "ent_d5plp31j18o8ibogtc8g",
"individual": {
"date_of_birth": "1990-05-15",
"national_identification_number": {
"type": "passport",
"number": "P1234567",
"issuer": {
"country": "SG",
"state": ""
},
"expiration": "2030-05-14",
"country_of_citizenship": "SG"
},
"nationality": "SG",
"profession": {
"occupation": "Software Engineer",
"isco_code": "2512",
"industry": "Technology",
"employment_status": "employed"
},
"source_of_funds": {
"primary_source": "salary",
"description": ""
},
"employment_details": {
"employer_name": "Acme Corp",
"designation": "Senior Engineer"
}
},
"transaction_profile": {
"monthly_expected_transactions_value": 10000,
"monthly_expected_transaction_volume": 5,
"expected_transaction_countries": ["SG", "US"],
"expected_transaction_currencies": ["USD", "SGD"],
"customer_risk": "low"
},
"name": "JOHN WONG",
"object": "entity",
"phone": {},
"purpose_of_use": [
"collect",
"payout"
],
"reference_id": "A1000003",
"registration_address": {
"city": "SG",
"country": "SG",
"line1": "123 Street 3/5",
"line2": "",
"postal_code": "123123",
"state": "SG"
},
"relationship": "customer",
"submit": true,
"submitted_at": "2026-01-23T11:33:32.060329Z",
"type": "individual"
},
"id": "evt_d62qf1rf3su1i69ash4g",
"object": "event",
"type": "entity.approval_rejected"
}