Feel free to reach techsupport@surepass.io for any technical support or guidance.
Upload PDF
Production
<AWS S3 URL FROM PREVIOUS REQ>
Production
<AWS S3 URL FROM PREVIOUS REQ>
POST
<AWS S3 URL FROM PREVIOUS REQ>
Upload PDF
Endpoint Overview
POST {upload_url}Description
Key Benefits
Use Cases
Financial Services
Healthcare
Employment Verification
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 Different authentication tokens are used for sandbox and production environments: Sandbox: Production:
1.
2.
3.
Authorization header as Bearer TOKEN.https://sandbox.surepass.iohttps://kyc-api.surepass.ioRequest Parameters
Request Headers
| Header | Required | Description |
|---|---|---|
| Authorization | Yes | Bearer token authentication using JWT token |
| Content-Type | Yes | Must be set to multipart/form-data for file uploads |
Request Body
| Parameter | Type | Required | Description |
|---|---|---|---|
| file | File | Yes | The PDF document to be uploaded |
| key | String | Yes | The unique key received from the Get Upload Link response |
| AWSAccessKeyId | String | Yes | AWS access key ID received from the Get Upload Link response |
| policy | String | Yes | Upload policy received from the Get Upload Link response |
| signature | String | Yes | Signature for upload verification received from the Get Upload Link response |
| x-amz-security-token | String | Yes | Security token received from the Get Upload Link response |
Example Request
# This is a multipart/form-data request with the following form fields:
file: [Binary PDF file data]
key: "documents/user123/passport.pdf"
AWSAccessKeyId: "AKIAIOSFODNN7EXAMPLE"
policy: "eyJleHBpcmF0aW9uIjoiMjAyMy0xMi0zMVQwMDowMDowMFoiLCJjb..."
signature: "qKNkVRrZ+qPzxNYOtm+qHg9F4ck="
x-amz-security-token: "IQoJb3JpZ2luX2VjEHgaCXVzLWVhc3QtMSJHMEU..."Process Response
Response Parameters
| Parameter | Type | Description |
|---|---|---|
| status | String | Status of the upload operation (success/failure) |
| message | String | Descriptive message about the upload result |
| document_id | String | Unique identifier for the uploaded document |
| timestamp | String | Timestamp of when the document was uploaded |
Example Successful Response
{
"status": "success",
"message": "Document uploaded successfully",
"document_id": "doc_12345abcde",
"timestamp": "2023-07-15T14:32:21Z"
}Possible Error Responses
Authentication Error
Invalid Parameters
File Error
{
"status": "error",
"error_code": "AUTH_FAILED",
"message": "Invalid or expired authentication token"
}Integration Best Practices
Security Recommendations
User Experience Guidelines
Code Samples
cURL
Python
Node.js
Related APIs
Compliance and Legal Considerations
Request
Body Params multipart/form-data
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '<AWS S3 URL FROM PREVIOUS REQ>/' \
--form 'x-amz-signature="{{signature}}"' \
--form 'x-amz-date="{{date}}"' \
--form 'x-amz-credential="{{credentials}}"' \
--form 'key="{{upload_key}}"' \
--form 'policy="{{policy}}"' \
--form 'x-amz-algorithmm="{{algorithm}}"' \
--form 'file=@""'Response Response Example
{}