Users
Track user onboarding and KYC webhook events, including status descriptions and sample payloads.
Use these webhook events to track user onboarding and KYC status changes in real time.
Check the status field in each webhook payload to identify the current user or KYC event.
| Status (Individual user) | Status (Business user) | Description | Webhook notification |
|---|---|---|---|
user_created | user_created | User has created the account in TransFi. | Yes |
user_approved | user_approved | User account has been approved in basic screening level. | Yes |
user_rejected | user_rejected | User account has been rejected in TransFi. | Yes |
kyc_initiated | kyb_initiated | KYC / KYB process has been initiated for the user. | Yes |
kyc_pending | kyb_pending | KYC / KYB process has been submitted and is pending verification. | Yes |
kyc_success | kyb_success | Uploaded details are successfully verified and approved on our KYC / KYB partner and compliance checks. | Yes |
kyc_failed | kyb_failed | KYC / KYB verification of the user has failed. (User can resubmit) | Yes |
kyc_manual_review | kyb_manual_review | Compliance review is in progress to approve or reject the KYC / KYB. | Yes |
kyc_rejected | kyb_rejected | Uploaded details are not approved on our KYC / KYB partner and compliance checks. | Yes |
kyc_blocked | kyb_blocked | KYC / KYB has been blocked for future transactions. | Yes |
kyc_expired | kyb_expired | KYC / KYB document for an existing user has expired and was identified during the ongoing monitoring process. | Yes |
Sample events for user webhooks
The payload structure remains the same across these events. The main value that changes is the status field.
Individual user
{
"eventId": "EV-231107XXXXX4387",
"entityId": "UX-231107XXXXX1115",
"entityType": "user",
"status": "user_created",
"user": {
"userId": "UX-231107XXXXX1115",
"firstName": "Nandhirajan",
"lastName": "Pandiraj",
"country": "EU",
"createdAt": "2023-11-08T00:00:00.004+04:00"
},
"order": {}
}{
"eventId": "EV-231107XXXXX4387",
"entityId": "UX-231107XXXXX1115",
"entityType": "user",
"status": "user_rejected",
"user": {
"userId": "UX-231107XXXXX1115",
"firstName": "Nandhirajan",
"lastName": "Pandiraj",
"country": "EU",
"createdAt": "2023-11-08T00:00:00.004+04:00"
},
"order": {},
"partnerContext": "TESTNZZ6WFX"
}{
"eventId": "EV-231107XXXXX4387",
"entityId": "UX-231107XXXXX1115",
"entityType": "user",
"status": "user_approved",
"user": {
"userId": "UX-231107XXXXX1115",
"firstName": "Nandhirajan",
"lastName": "Pandiraj",
"country": "EU",
"createdAt": "2023-11-08T00:00:00.004+04:00"
},
"order": {},
"partnerContext": "TESTNZZ6WFX"
}{
"eventId": "EV-231107XXXXX4387",
"entityId": "UX-231107XXXXX1115",
"entityType": "user",
"status": "kyc_initiated",
"user": {
"userId": "UX-231107XXXXX1115",
"firstName": "Nandhirajan",
"lastName": "Pandiraj",
"country": "EU",
"createdAt": "2023-11-08T00:00:00.004+04:00"
},
"order": {},
"partnerContext": "TESTNZZ6WFX"
}{
"eventId": "EV-231107XXXXX4387",
"entityId": "UX-231107XXXXX1115",
"entityType": "user",
"status": "kyc_pending",
"user": {
"userId": "UX-231107XXXXX1115",
"firstName": "Nandhirajan",
"lastName": "Pandiraj",
"country": "EU",
"createdAt": "2023-11-08T00:00:00.004+04:00"
},
"order": {},
"partnerContext": "TESTNZZ6WFX"
}{
"eventId": "EV-231107XXXXX4387",
"entityId": "UX-231107XXXXX1115",
"entityType": "user",
"status": "kyc_success",
"user": {
"userId": "UX-231107XXXXX1115",
"firstName": "Nandhirajan",
"lastName": "Pandiraj",
"country": "EU",
"createdAt": "2023-11-08T00:00:00.004+04:00"
},
"order": {},
"partnerContext": "TESTNZZ6WFX"
}{
"eventId": "EV-231107XXXXX4387",
"entityId": "UX-231107XXXXX1115",
"entityType": "user",
"status": "kyc_rejected",
"user": {
"userId": "UX-231107XXXXX1115",
"firstName": "Nandhirajan",
"lastName": "Pandiraj",
"country": "EU",
"createdAt": "2023-11-08T00:00:00.004+04:00"
},
"order": {},
"partnerContext": "TESTNZZ6WFX"
}{
"eventId": "EV-231107XXXXX4387",
"entityId": "UX-231107XXXXX1115",
"entityType": "user",
"status": "kyc_failed",
"user": {
"userId": "UX-231107XXXXX1115",
"firstName": "Nandhirajan",
"lastName": "Pandiraj",
"country": "EU",
"createdAt": "2023-11-08T00:00:00.004+04:00"
},
"order": {},
"partnerContext": "TESTNZZ6WFX"
}{
"eventId": "EV-231107XXXXX4387",
"entityId": "UX-231107XXXXX1115",
"entityType": "user",
"status": "kyc_manual_review",
"user": {
"userId": "UX-231107XXXXX1115",
"firstName": "Nandhirajan",
"lastName": "Pandiraj",
"country": "EU",
"createdAt": "2023-11-08T00:00:00.004+04:00"
},
"order": {},
"partnerContext": "TESTNZZ6WFX"
}{
"eventId": "EV-231107XXXXX4387",
"entityId": "UX-231107XXXXX1115",
"entityType": "user",
"status": "kyc_blocked",
"user": {
"userId": "UX-231107XXXXX1115",
"firstName": "Nandhirajan",
"lastName": "Pandiraj",
"country": "EU",
"createdAt": "2023-11-08T00:00:00.004+04:00"
},
"order": {},
"partnerContext": "TESTNZZ6WFX"
}{
"eventId": "EV-231107XXXXX4387",
"entityId": "UX-231107XXXXX1115",
"entityType": "user",
"status": "kyc_expired",
"user": {
"userId": "UX-231107XXXXX1115",
"firstName": "Nandhirajan",
"lastName": "Pandiraj",
"country": "EU",
"createdAt": "2023-11-08T00:00:00.004+04:00"
},
"order": {},
"partnerContext": "TESTNZZ6WFX"
}Business user
{
"eventId": "EV-231107XXXXX4387",
"entityId": "UX-231107XXXXX1115",
"entityType": "user",
"status": "user_created",
"user": {
"userId": "UX-231107XXXXX1115",
"firstName": "Nandhirajan",
"lastName": "Pandiraj",
"country": "EU",
"createdAt": "2023-11-08T00:00:00.004+04:00"
},
"order": {}
}{
"eventId": "EV-231107XXXXX4387",
"entityId": "UX-231107XXXXX1115",
"entityType": "user",
"status": "user_rejected",
"user": {
"userId": "UX-231107XXXXX1115",
"firstName": "Nandhirajan",
"lastName": "Pandiraj",
"country": "EU",
"createdAt": "2023-11-08T00:00:00.004+04:00"
},
"order": {},
"partnerContext": "TESTNZZ6WFX"
}{
"eventId": "EV-231107XXXXX4387",
"entityId": "UX-231107XXXXX1115",
"entityType": "user",
"status": "user_approved",
"user": {
"userId": "UX-231107XXXXX1115",
"firstName": "Nandhirajan",
"lastName": "Pandiraj",
"country": "EU",
"createdAt": "2023-11-08T00:00:00.004+04:00"
},
"order": {},
"partnerContext": "TESTNZZ6WFX"
}{
"eventId": "EV-231107XXXXX4387",
"entityId": "UX-231107XXXXX1115",
"entityType": "user",
"status": "kyb_initiated",
"user": {
"userId": "UX-231107XXXXX1115",
"firstName": "Nandhirajan",
"lastName": "Pandiraj",
"country": "EU",
"createdAt": "2023-11-08T00:00:00.004+04:00"
},
"order": {},
"partnerContext": "TESTNZZ6WFX"
}{
"eventId": "EV-231107XXXXX4387",
"entityId": "UX-231107XXXXX1115",
"entityType": "user",
"status": "kyb_pending",
"user": {
"userId": "UX-231107XXXXX1115",
"firstName": "Nandhirajan",
"lastName": "Pandiraj",
"country": "EU",
"createdAt": "2023-11-08T00:00:00.004+04:00"
},
"order": {},
"partnerContext": "TESTNZZ6WFX"
}{
"eventId": "EV-231107XXXXX4387",
"entityId": "UX-231107XXXXX1115",
"entityType": "user",
"status": "kyb_success",
"user": {
"userId": "UX-231107XXXXX1115",
"firstName": "Nandhirajan",
"lastName": "Pandiraj",
"country": "EU",
"createdAt": "2023-11-08T00:00:00.004+04:00"
},
"order": {},
"partnerContext": "TESTNZZ6WFX"
}{
"eventId": "EV-231107XXXXX4387",
"entityId": "UX-231107XXXXX1115",
"entityType": "user",
"status": "kyb_rejected",
"user": {
"userId": "UX-231107XXXXX1115",
"firstName": "Nandhirajan",
"lastName": "Pandiraj",
"country": "EU",
"createdAt": "2023-11-08T00:00:00.004+04:00"
},
"order": {},
"partnerContext": "TESTNZZ6WFX"
}{
"eventId": "EV-231107XXXXX4387",
"entityId": "UX-231107XXXXX1115",
"entityType": "user",
"status": "kyb_failed",
"user": {
"userId": "UX-231107XXXXX1115",
"firstName": "Nandhirajan",
"lastName": "Pandiraj",
"country": "EU",
"createdAt": "2023-11-08T00:00:00.004+04:00"
},
"order": {},
"partnerContext": "TESTNZZ6WFX"
}{
"eventId": "EV-231107XXXXX4387",
"entityId": "UX-231107XXXXX1115",
"entityType": "user",
"status": "kyb_manual_review",
"user": {
"userId": "UX-231107XXXXX1115",
"firstName": "Nandhirajan",
"lastName": "Pandiraj",
"country": "EU",
"createdAt": "2023-11-08T00:00:00.004+04:00"
},
"order": {},
"partnerContext": "TESTNZZ6WFX"
}{
"eventId": "EV-231107XXXXX4387",
"entityId": "UX-231107XXXXX1115",
"entityType": "user",
"status": "kyb_blocked",
"user": {
"userId": "UX-231107XXXXX1115",
"firstName": "Nandhirajan",
"lastName": "Pandiraj",
"country": "EU",
"createdAt": "2023-11-08T00:00:00.004+04:00"
},
"order": {},
"partnerContext": "TESTNZZ6WFX"
}{
"eventId": "EV-231107XXXXX4387",
"entityId": "UX-231107XXXXX1115",
"entityType": "user",
"status": "kyb_expired",
"user": {
"userId": "UX-231107XXXXX1115",
"firstName": "Nandhirajan",
"lastName": "Pandiraj",
"country": "EU",
"createdAt": "2023-11-08T00:00:00.004+04:00"
},
"order": {},
"partnerContext": "TESTNZZ6WFX"
}Updated 8 days ago