Set Branding

Endpoint Overview

POST /api/v1/esign/set-branding

Description

This API endpoint allows you to customize the branding elements that appear on e-signature documents and interfaces. By setting your brand image and name, you can provide a consistent, branded experience to your customers during the e-signature process, increasing trust and recognition.

Key Benefits

Maintain brand consistency throughout the e-signature workflow

Enhance customer trust with familiar branding elements

Improve user experience with professional, branded documents

Seamlessly integrate e-signature capabilities into your existing brand identity

Use Cases

Financial Services

Real Estate

Legal Services

Customize loan agreement documents with bank branding

Brand insurance policy e-signature flows for customer recognition

Maintain corporate identity across wealth management document signing

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	Bearer token for authentication (JWT)
Content-Type	Yes	application/json

Request Body

Parameter	Type	Required	Description
brand_image_url	String	Yes	URL of the brand image to be displayed on e-signature documents and interfaces
brand_name	String	Yes	Name of the brand to be displayed on e-signature documents and interfaces

Example Request

{
    "brand_image_url": "https://random.io/wp-content/uploads/2019/09/2-layers@2x.png",
    "brand_name": "Random"
}

Process Response

Response Parameters

Parameter	Type	Description
data	Object	Contains response data (may be empty if no specific data is returned)
status_code	Integer	HTTP status code indicating the result of the operation
message_code	String	Code indicating the result status (e.g., "success")
message	String or null	Additional message details (null if no message)
success	Boolean	Indicates if the operation was successful
client_id	String	Unique identifier of this object/query (returned in data object)
token	String	Token generated for use by SDK (returned in data object)
url	String	URL generated for use by SDK/Customer (returned in data object)

Example Successful Response

{
    "data": {},
    "status_code": 200,
    "message_code": "success",
    "message": null,
    "success": true
}

Possible Error Responses

Authentication Error

Validation Error

{
    "data": {},
    "status_code": 401,
    "message_code": "unauthorized",
    "message": "Invalid or expired authentication token",
    "success": false
}

This error occurs when the JWT token is invalid, expired, or missing.

Integration Best Practices

Security Recommendations

Store JWT tokens securely and never expose them in client-side code

Use HTTPS for brand image URLs to ensure secure loading

Implement proper error handling to manage authentication failures gracefully

Rotate JWT tokens periodically to minimize security risks

User Experience Guidelines

Use high-quality brand images with transparent backgrounds for best results

Ensure brand images are optimized for both mobile and desktop viewing

Test the branding appearance across different document types

Keep brand names concise to ensure they display properly on all devices

Code Samples

cURL

Python

Node.js

Related APIs

Create E-Sign Request: Creates a new electronic signature request

Get E-Sign Status: Retrieves the current status of an e-signature request

Cancel E-Sign Request: Cancels an in-progress e-signature request

Compliance and Legal Considerations

When implementing e-signature solutions, ensure compliance with relevant electronic signature laws such as eIDAS (EU), ESIGN Act (US), or equivalent regulations in your jurisdiction. Branding should not obscure legally required disclosures or interfere with the clarity of signature areas.

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/esign/set-branding' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data-raw '{ "brand_image_url": "https://random.io/wp-content/uploads/2019/09/2-layers@2x.png", "brand_name": "Random" }'

Set Branding

Set Branding#

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

Set Branding

Description

Use Cases

Technical Implementation

Request Headers

Request Body

Example Request

Response Parameters

Example Successful Response

Possible Error Responses

Integration Best Practices

Code Samples