Feel free to reach techsupport@surepass.io for any technical support or guidance.
⭐️ Initialize via iOS SDK
Production
https://kyc-api.surepass.app
Production
https://kyc-api.surepass.app
POST
https://kyc-api.surepass.app
Initialize via iOS SDK
Description
Key Benefits
Use Cases
Fintech
Healthcare
Education
Technical Implementation
Step 1: Generate Your SDK Token
Before integrating the SDK, obtain an authentication token from the Digiboost API.Contact your Surepass sales manager to receive: Digilocker initialize endpoint URL Authorization Bearer Token (required for API access) Access permissions Choose your environment: UAT (Testing): Production: Call the Digilocker Initialize API with your configuration.
1.
2.
https://sandbox.surepass.apphttps://kyc-api.surepass.app3.
Request
Request Headers
| Header | Required | Description |
|---|---|---|
| Content-Type | Yes | Must be application/json |
| Authorization | Yes | Bearer token from Surepass |
Request Body
| Parameter | Type | Required | Description | Default |
|---|---|---|---|---|
| signup_flow | boolean | Yes | Always set to true for SDK initialization | true |
| auth_type | string | Yes | Authentication type - must be set to "app" for SDK integration | "app" |
| logo_url | string | No | URL for your brand logo | None |
| voice_assistant_lang | string | No | "en" (English) or "hi" (Hindi) | "en" |
| voice_assistant | boolean | No | Enable/disable voice assistant | false |
| retry_count | integer | No | Number of allowed retries | 2 |
| skip_main_screen | boolean | No | Skip intro screen if true | true |
Example Request
{
"data": {
"signup_flow": true,
"auth_type": "app",
"logo_url": "https://yourbrand.com/logo.png",
"voice_assistant_lang": "en",
"voice_assistant": false,
"retry_count": 2,
"skip_main_screen": false
}
}Step 2: Process the API Response
Response
| Parameter | Type | Description |
|---|---|---|
| data.client_id | string | Unique client identifier |
| data.token | string | JWT token for SDK session |
| data.expiry_seconds | float | Token validity duration in seconds |
| status_code | int | HTTP status code |
| message_code | string | Status message code |
| message | string | Human-readable status message |
| success | boolean | Indicates if the request was successful |
Example Successful Response
{
"data": {
"client_id": "digilocker_cntWpMxWHbcvgghtyvxw",
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
"expiry_seconds": 600.0
},
"status_code": 200,
"message_code": "success",
"message": "Success",
"success": true
}Possible Error Responses
Invalid Token
Missing Parameters
Internal Error
{
"status_code": 401,
"message_code": "invalid_token",
"message": "Authorization token is invalid or expired",
"success": false
}Step 3: Install the SDK via Swift Package Manager
Xcode Integration:Go to Select the version (1.0.0+) and add to your target Or add to your
1.
File → Add Package Dependencies3.
Package.swift:Step 4: Quick Start Integration
1.
2.
Step 5: Theme Customization (Optional)
Customize the SDK’s accent color to match your app’s branding:
Step 6: Error Handling & Troubleshooting
onFailure callback for error handling:Request
Body Params application/json
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://kyc-api.surepass.app/api/v1/digilocker/initialize' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
"data": {
"signup_flow": true,
"auth_type": "app"
}
}'Response Response Example
{
"data": {
"client_id": "digilocker_cntWpMxWHbcvgghtyvxw",
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
"expiry_seconds": 600.0
},
"status_code": 200,
"message_code": "success",
"message": "Success",
"success": true
}