Stages and statuses
Onboarding stages
currentStage in List Business Profiles, Get Business Profile and Get Business Profile by Reference is a string, the furthest stage the business has completed.
currentStage | When a business you onboard has it |
|---|---|
CompletedBusinessDetail | From Create Business Profile onwards. Create completes the business details in the same call. |
Submitted | After a change request is answered: once every rejected document you can upload has a replacement that passed its scan. |
The other stage names, Draft, CompletedUboDetails and CompletedBusinessDocumentUpload, belong to onboarding in the ryno business app. A business created through the API does not report them.
Verification statuses
verificationStatus in List Business Profiles, Get Business Profile, Get Business Profile by Reference and Get Verification Status is a string, one of:
verificationStatus | Meaning |
|---|---|
PendingVerification | Queued for compliance review. Create Business Profile sets it. |
InReview | A compliance analyst is reviewing the business. Updates are refused. |
ChangesRequested | Compliance needs more information. Get Verification Status gives the analyst's rejectionReason and lists the rejectedDocuments to replace. See Answering a change request. |
ChangesRequestCompleted | Every rejected document you can upload has a replacement that passed its scan. The case is back in the review queue. |
Approved | Onboarding is approved. |
Rejected | Onboarding was rejected. See rejectionReason. |
Archived | The customer record was archived. |
NotStarted and StartedNotCompleted belong to onboarding in the ryno business app. A business created through the API starts at PendingVerification.
Decisions (Approved, Rejected, ChangesRequested) are also pushed to you as webhook events.
Answering a change request
A change request always rejects at least one document.
- On
customer., call Get Verification Status.onboarding. changes_requested rejectionReasonis the analyst's message;rejectedDocumentslists each document to replace, with the analyst'scomment. - For each rejected document, request an upload link in the same
documentCategory, optionally with itsdocumentIdasreplacesDocumentId, and upload the new file. Each file replaces one rejected document; a file in another category does not count. - Fix any fields the analyst asked about with Update Business Profile.
When the last replacement passes its scan, the status moves to ChangesRequestCompleted and the analyst picks the case back up. You don't need a separate call for that. An Update Business Profile call made before then saves your changes but leaves the status at ChangesRequested.
- Fix fields first. The case goes back to the analyst as soon as the last replacement passes its scan, so send field fixes before, or in the same call as, your last replacement.
- A document you cannot upload. A listed document with
canReplace: falsecannot be uploaded through the API: it belongs to one of the business's people, it has nodocumentCategory, or its category is not offered for the business now (for example after you changebusinessTypeCode). You don't need to replace it; the analyst resolves it when the case comes back.