UDIN Submit OTP API

Endpoint Overview

POST /api/v1/udin/submit-otp

Description

The UDIN Submit OTP API completes the two-factor authentication process by validating the OTP codes sent to both mobile and email addresses. Upon successful verification, this endpoint retrieves comprehensive professional details including certification information, firm details, financial particulars, and professional status from the UDIN database. This API serves as the final verification step that unlocks access to detailed professional credential data.

The endpoint processes dual OTP validation (mobile and email) to ensure maximum security and returns rich professional information including signing dates, document types, certificate details, and financial figures, making it essential for thorough professional verification workflows.

Key Benefits

Dual OTP Verification: Enhanced security through both mobile and email OTP validation

Comprehensive Data Retrieval: Access to detailed professional information, certifications, and financial data

Real-time Validation: Instant verification with immediate access to professional credentials

Secure Session Management: Client ID-based session tracking for secure multi-step verification

Use Cases

Financial Services

Professional Services

Regulatory Compliance

Professional verification for loan applications and credit assessments

KYC compliance for chartered accountants and financial advisors

Due diligence verification for investment advisory services

Professional credential validation for fintech partnerships

Technical Implementation

Authentication

All API requests require authentication using a JWT Bearer token. Authentication follows these steps:

Obtain API Credentials: Register with Surepass to receive your API key.

Generate JWT Token: Use your API key to generate a JWT token.

Include in Requests: Add the token to the Authorization header as Bearer TOKEN.

Different authentication tokens are used for sandbox and production environments:

Sandbox: https://sandbox.surepass.app

Production: https://kyc-api.surepass.app

Request Parameters

Request Headers

Header	Required	Description
Authorization	Yes	Bearer token for API authentication
Content-Type	Yes	Must be set to `application/json`

Request Body

Parameter	Type	Required	Description
client_id	string	Yes	Unique client identifier received from the send-otp endpoint
mobile_otp	string	Yes	OTP code received on the registered mobile number
email_otp	string	Yes	OTP code received on the registered email address

Example Request

{
  "client_id": "udin_yZzYusgmxrzihbQldRHE",
  "mobile_otp": "71473",
  "email_otp": "92016"
}

Process Response

Response Parameters

Parameter	Type	Description
data	object	Container for all professional information
data.client_id	string	Unique client session identifier
data.id_number	string	UDIN identification number
data.email_id	string	Verified email address
data.mobile_number	string	Verified mobile number
data.signing_date	string	Date when the professional document was signed
data.name	string	Full name of the professional
data.firm_details	string	Details about the professional's firm
data.document_type	string	Type of professional document
data.certificate_type	string	Category of professional certificate
data.document_description	string	Description of the verified documents
data.status	string	Current status of the professional registration
data.figures_particulars	array	Array of financial and professional particulars
status_code	integer	HTTP status code of the response
success	boolean	Indicates if the request was successful
message	string	Human-readable response message
message_code	string	Machine-readable response code

Example Successful Response

{
  "data": {
    "client_id": "udin_dOLoUJUkAgjjFjeFtreT",
    "id_number": "21153743AAAADQ1234",
    "email_id": "abc@gmail.com",
    "mobile_number": "9876341246",
    "signing_date": "2021-04-16",
    "name": "ABHIJIT SHETYE",
    "firm_details": "",
    "document_type": "Certificates",
    "certificate_type": "Others",
    "document_description": "Verified Relevant Documents",
    "status": "Active",
    "figures_particulars": [
      "Total Professional Fee Recd:INR 613200",
      "Net Profit FY 2019-20:INR 393748",
      "Capital A/c as on 31.03.2020:INR 117360"
    ]
  },
  "status_code": 200,
  "success": true,
  "message": "Success",
  "message_code": "success"
}

Possible Error Responses

Invalid Email OTP

Invalid Mobile OTP

Invalid Client ID

{
    "status_code": 422,
    "success": false,
    "message": "Invalid Email OTP.",
    "message_code": "verification_failed"
}

This error occurs when email OTP is incorrect or has expired.

Integration Best Practices

Security Recommendations

Store OTP codes securely and clear them from memory immediately after use

Implement proper session timeout mechanisms for client_id management

Validate both mobile and email OTPs before making the API call

Use HTTPS for all API communications to protect sensitive data transmission

User Experience Guidelines

Provide clear instructions for users to check both mobile and email for OTP codes

Implement proper error handling with user-friendly messages for invalid OTPs

Show loading states while the API processes the OTP verification

Display comprehensive professional information in a well-organized format after successful verification

Code Samples

cURL

Python

Node.js

Related APIs

UDIN Send OTP API: Initiates the verification process by sending OTP codes to mobile and email

Professional Verification APIs: Additional endpoints for comprehensive professional background verification

Document Verification APIs: Related services for validating professional certificates and documents

Compliance and Legal Considerations

This API processes sensitive professional and financial information. Ensure compliance with data protection regulations such as GDPR and local privacy laws. The financial particulars and professional details returned should be handled according to your organization's data retention and privacy policies. Professional information should only be used for legitimate verification purposes and not for unauthorized financial profiling.

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

curl --location --request POST 'https://kyc-api.surepass.app/api/v1/udin/submit-otp' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data-raw '{ "client_id": "udin_yZzYusgmxrzihbQldRHE", "mobile_otp": "71473", "email_otp": "92016" }'

{ "data": { "client_id": "udin_dOLoUJUkAgjjFjeFtreT", "id_number": "21153743AAAADQ1234", "email_id": "abc@gmail.com", "mobile_number": "9876341246", "signing_date": "2021-04-16", "name": "ABHIJIT SHETYE", "firm_details": "", "document_type": "Certificates", "certificate_type": "Others", "document_description": "Verified Relevant Documents", "status": "Active", "figures_particulars": [ "Total Professional Fee Recd:INR 613200", "Net Profit FY 2019-20:INR 393748", "Capital A/c as on 31.03.2020:INR 117360" ] }, "status_code": 200, "success": true, "message": "Success", "message_code": "success" }

UDIN Submit OTP

UDIN Submit OTP API#

Description#

Use Cases#

Technical Implementation#

Request Headers#

Request Body#

Example Request#

Response Parameters#

Example Successful Response#

Possible Error Responses#

Integration Best Practices#

Code Samples#

Request

Responses