Request Kyb Resubmission

Request resubmission of a business's failed verification steps on the
existing session. Allowed while KYB is pending or rejected.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Reopens a business customer's failed verification steps on its existing verification session so the business can redo just the flagged steps, without starting a brand-new verification. The endpoint inspects the latest verification decision, reopens only the user-fixable steps that were declined, transitions the business back to pending (when it was rejected), records an audit entry, and returns the verification link to share with the business.

This is available only for UrbanpayX-managed KYB. It does not apply to businesses configured for external attestation.

Authentication & access

  • Requires a client API token: Authorization: Bearer <token>.
  • The caller must hold the kyb.verification.resubmit permission and have the OWNER or OPERATIONS role.

Path parameters

NameInDescription
business_customer_idpathThe business customer whose verification steps should be reopened. Must belong to your client.

This endpoint takes no request body.

Preconditions

The request is rejected unless all of the following hold:

  • The business uses UrbanpayX-managed KYB, not external attestation.
  • The business has an active verification session to resubmit against.
  • The business is not already approved.
  • The business's kyb_status is rejected or pending (a resubmittable state).
  • The verification session has not expired. If it has, start verification again instead of resubmitting.
  • At least one declined step is self-resubmittable (a step the business can redo, such as document, selfie, liveness, or address). If the failure is a compliance or risk check, self-resubmission is blocked and the case must be handled through support.

What it does

When the preconditions pass, the flagged steps on the existing session are reopened so the business can redo only those steps. If the business was rejected, its kyb_status is moved back to pending; if it was already pending, the status is left unchanged. The action is written to the audit log.

Response

200 OK returns a KybResubmitResponse:

  • business_customer_id — the business customer id.
  • kyb_status — the resulting status (pending after a successful resubmission request).
  • session_url — the verification link to share with the business so it can redo the flagged steps. May be null if no link is available.
  • resubmit_steps — the neutral names of the steps reopened for resubmission (e.g. document, selfie, liveness, address).
  • message — a human-readable summary.

Error responses

StatusWhen
400The business is configured for external attestation; there is no active verification session; or kyb_status is not in a resubmittable state.
404No business customer with this id exists under your client.
409The business is already verified; the verification session has expired; or there are no failed steps available to resubmit.
422The failure is a compliance or risk check that cannot be self-resubmitted (route to support).
503UrbanpayX-managed verification is not configured on the platform.

Standard 401 (authentication), 403 (insufficient permission or role), and 429 (rate limit) responses apply to every endpoint and are documented in the Error reference.

Path Params
string
required
Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json