After Paystrator sends KYB data to the provider, it is essential for the provider to actively report the onboarding status to ensure both systems stay synchronized.
This status update flow allows:
- Transparent tracking of each client’s onboarding journey
- Smooth coordination between Paystrator and provider systems
- Triggering follow-up actions like endpoint testing or client notification
By implementing this API, providers help ensure real-time feedback, reduce back-and-forth communication, and accelerate the transition from approval to production.
✳️ When to Use This API
- Immediately after receiving KYB data
- When KYB enters internal review
- After KYB is approved or rejected
- After integration testing is complete and provider is ready to go live
🔁 Status Update Endpoint
POST https://api.paystrator.com/v1/onboarding/status
Content-Type: application/json
Authorization: Bearer {provider_api_key}📤 Payload from Provider
{
"reference_id": "paystrator-kyb-90210",
"status": "processing"
}The
reference_idis provided by Paystrator when the KYB data is first pushed to the provider. It is used to track onboarding progress.
✅ Valid Status Values
| Status | Description |
|---|---|
received | Acknowledges KYB data has been received |
processing | Provider is actively reviewing the KYB information |
rejected | KYB has been declined |
approved | KYB has been accepted and passed verification |
🧭 Visual Flow Overview
