Nurse Verification

Endpoint Overview

POST /api/v1/nuid/nuid-verification

Description

This API endpoint allows you to verify a nurse's professional credentials by providing their nurse ID number. The service validates the nurse's license against official records and returns comprehensive details including the nurse's name, registration status, state council, and whether their license is active.

Key Benefits

Instant verification of nurse credentials without manual paperwork

Reduces hiring risks by confirming license validity and status

Ensures compliance with healthcare regulatory requirements

Streamlines healthcare staff onboarding processes

Use Cases

Healthcare Facilities

Staffing Agencies

Telemedicine Platforms

Verify credentials during nurse hiring processes

Conduct periodic compliance checks of existing nursing staff

Validate temporary or contract nursing personnel credentials

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.io

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

Request Parameters

Request Headers

Header	Required	Description
Authorization	Yes	JWT Bearer token for authentication (format: `Bearer YOUR_TOKEN`)
Content-Type	Yes	Must be set to `application/json`

Request Body

Parameter	Type	Required	Description
id_number	String	Yes	Nurse ID Number/License Number (e.g., "UP12345")

Example Request

{
    "id_number": "UP12345"
}

Process Response

Response Parameters

Parameter	Type	Description
data	Object	Container for the verification result data
data.client_id	String	Unique identifier for this verification request
data.id_number	String	The nurse license number that was verified
data.nurse_name	String	Full name of the registered nurse
data.state_council	String	Medical state council where the nurse is registered
data.registered_as	String	Registration category or designation
data.status	String	Current license status (e.g., "Active")
status_code	Integer	HTTP status code of the response
success	Boolean	Indicates if the verification was successful
message	String	Human-readable status message
message_code	String	Machine-readable status code

Example Successful Response

{
    "data": {
        "client_id": "nuid_iJdaIfMygwJRqoeFhJlp",
        "id_number": "UP12345",
        "nurse_name": "V Singh",
        "state_council": "Lucknow",
        "registered_as": "okok",
        "status": "Active"
    },
    "status_code": 200,
    "success": true,
    "message": "Success",
    "message_code": "success"
}

Possible Error Responses

Invalid ID Number

ID Not Found

Authentication Error

{
    "status_code": 400,
    "success": false,
    "message": "Invalid nurse ID number format",
    "message_code": "invalid_id_format"
}

The provided nurse ID number is in an invalid format or doesn't match expected patterns.

Integration Best Practices

Security Recommendations

Store API credentials securely and never expose them in client-side code

Implement proper error handling to avoid exposing sensitive information

Rotate JWT tokens periodically and don't reuse them across different applications

Implement rate limiting on your end to prevent abuse of the API

User Experience Guidelines

Provide clear feedback to users when verification is in progress

Display verification results in an easy-to-understand format

Implement caching for frequently verified IDs to improve response times

Include a timestamp of when the verification was performed

Code Samples

cURL

Python

Node.js

Related APIs

Healthcare Professional Verification API: Verify credentials for doctors and other healthcare professionals

Medical License Status Check API: Check the current status of any medical professional license

Bulk Verification API: Verify multiple nurse IDs in a single request for efficient processing

Compliance and Legal Considerations

This API provides access to personal and professional information that may be subject to privacy regulations. Ensure your use of this data complies with relevant healthcare privacy laws (such as HIPAA in the US or similar regulations in other countries). Store verification results securely and only for the duration necessary for your business purposes.

curl --location --request POST 'https://kyc-api.surepass.app/api/v1/nuid/nuid-verification' \ --header 'Authorization: Bearer TOKEN' \ --header 'Content-Type: application/json' \ --data-raw '{ "id_number": "UP12345" }'

{ "data": { "client_id": "nuid_iJdaIfMygwJRqoeFhJlp", "id_number": "UP12345", "nurse_name": "V Singh", "state_council": "Lucknow", "registered_as": "okok", "status": "Active" }, "status_code": 200, "success": true, "message": "Success", "message_code": "success" }

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Nurse Verification

Nurse Verification#

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

Nurse Verification

Description

Use Cases

Technical Implementation

Request Headers

Request Body

Example Request

Response Parameters

Example Successful Response

Possible Error Responses

Integration Best Practices

Code Samples