Re-run KYC process

POST 
/v1/compliance/kyc/:onboardingId/rerun

Archives the existing onboarding and creates a new KYC process. Only allowed for PENDING or PROCESSING statuses. Returns new SDK link and QR code for document/biometric capture.

This endpoint is useful when:

• User entered incorrect data and needs to restart
• Documents expired and need to be re-uploaded
• User wants to update their information

The previous onboarding is archived (not deleted) for audit trail.

Request

Path Parameters

onboardingId stringrequired

Responses

200

KYC process restarted successfully with new SDK links

application/json

Schema

Schema

traceId string
message string

data

object

onboardingId stringrequired

Id of the started onboarding

sdk

object

If your kyc includes the document and liveness capture sdk flow, this property will provide you the links for the integration

link stringrequired

sdk link

qr_code stringrequired

QR code in base64 that redirects user to sdk link

Example (from schema)

{
  "traceId": "string",
  "message": "string",
  "data": {
    "onboardingId": "string",
    "sdk": {
      "link": "https://example.com?entityId=123e4567-e89b-12d3-a456-426614174021&journeyId=123e4567-e89b-12d3-a456-426614174021",
      "qr_code": "qr-code-base-64"
    }
  }
}

400

Invalid request payload. This can happen if required fields are missing or have invalid formats.

application/json

Schema

Schema

traceId string
message string

Example (from schema)

{
  "traceId": "string",
  "message": "string"
}

403

The API key is invalid or the client does not have sufficient permissions.

application/json

Schema

Schema

traceId string
message string

Example (from schema)

{
  "traceId": "string",
  "message": "string"
}

404

One of the specified resources was not found. Does not apply for empty result set.

application/json

Schema

Schema

traceId string
message string

Example (from schema)

{
  "traceId": "string",
  "message": "string"
}

Loading...