Get Onboarding Progress

Retrieve the onboarding progress for a business customer owned by the authenticated partner.

Endpoint

GET https://prod.rynopay.io/partner/v1/business-profiles/{customerId}/onboarding-progress

Path parameters

Parameter	Type	Description
customerId	UUID	The business customer ID returned from Create Business Profile

Example request

curl -X GET https://prod.rynopay.io/partner/v1/business-profiles/a1b2c3d4-e5f6-7890-abcd-ef1234567890/onboarding-progress \
  -H "Authorization: Bearer <access_token>"

Response

200 OK

{
  "isSuccess": true,
  "value": {
    "customerId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "customerType": "PartnerBusiness",
    "stages": [
      {
        "stage": 0,
        "stageName": "Draft",
        "isCompleted": true
      },
      {
        "stage": 1,
        "stageName": "CompletedBusinessDetail",
        "isCompleted": true
      },
      {
        "stage": 2,
        "stageName": "CompletedUboDetails",
        "isCompleted": false
      },
      {
        "stage": 3,
        "stageName": "CompletedBusinessDocumentUpload",
        "isCompleted": false
      },
      {
        "stage": 4,
        "stageName": "Submitted",
        "isCompleted": false
      }
    ],
    "currentStage": 1,
    "currentStageName": "CompletedBusinessDetail",
    "nextStage": 2,
    "nextStageName": "CompletedUboDetails",
    "progressPercentage": 40,
    "isOnboardingCompleted": false,
    "verificationStatus": "NotStarted"
  }
}

Response fields

Field	Type	Description
customerId	string (UUID)	The business customer ID
customerType	string	Customer type (e.g. PartnerBusiness)
stages	array	List of all onboarding stages with completion status
currentStage	integer	The last completed stage number
currentStageName	string	Human-readable name of the current stage
nextStage	integer	The next stage to complete (null if all done)
nextStageName	string	Human-readable name of the next stage (null if all done)
progressPercentage	integer	Completion percentage (0–100)
isOnboardingCompleted	boolean	Whether all onboarding stages are complete
verificationStatus	string	KYB verification status

Onboarding stages

Stage	Name	Description
0	Draft	Initial state after profile creation
1	CompletedBusinessDetail	Business details have been submitted
2	CompletedUboDetails	UBO information has been submitted
3	CompletedBusinessDocumentUpload	Required documents have been uploaded
4	Submitted	Application submitted for compliance review

Verification statuses

Value	Description
NotStarted	No compliance review has begun
StartedNotCompleted	Review is in progress
Approved	KYB verification approved
Rejected	KYB verification rejected
ChangesRequested	Additional information requested

400 Bad Request

{
  "isSuccess": false,
  "error": {
    "code": "Partner.NotAuthorized",
    "message": "You are not authorized to view this customer's onboarding progress"
  }
}

Possible error codes:

Code	Description
Partner.NotAuthenticated	Partner ID could not be resolved from the token
Partner.NotAuthorized	The customer does not belong to this partner
Customer.NotFound	No customer found with the given ID