Face Background Remover

Endpoint Overview

POST /api/v1/face/face-background-remover

Description

The Face Background Remover API automatically detects and isolates a face in an uploaded image, removing the background completely. This creates a clean, transparent background around the face, making it ideal for profile pictures, ID photos, and other applications where a consistent, distraction-free background is required.

Key Benefits

Instantly removes complex backgrounds from facial images without manual editing

Preserves facial details and natural edges for professional-looking results

Reduces image processing time from minutes to seconds

Provides consistent output format for standardized image processing workflows

Use Cases

Identity Verification

Digital Media

Retail & E-commerce

Creating standardized profile photos for KYC/eKYC processes

Generating uniform ID card photos with consistent backgrounds

Preparing passport-style photos that meet regulatory requirements

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_JWT_TOKEN`)
Content-Type	Yes	Must be set to `multipart/form-data` for file upload

Request Body

Parameter	Type	Required	Description
File	Image	Yes	The image file containing a face. Supported formats include JPG, JPEG, and PNG.
link	String	No	Image Link
face_crop	Boolean	No	Face Crop For Passport Size Photo

Example Request

Process Response

Response Parameters

Parameter	Type	Description
data	Object	Contains the result data
data.client_id	String	Unique identifier for the request/client
data.image_url	String	URL to access the processed image with background removed
face_crop	Boolean	Face Crop For Passport Size Photo
status_code	Integer	HTTP status code (200 for success)
success	Boolean	Indicates if the operation was successful
message	String	Human-readable status message
message_code	String	Machine-readable status code

Example Successful Response

{
    "data": {
        "client_id": "face_background_remover_MzERcZdynEfGggqKtnWz",
        "image_url": "https://aadhaar-kyc-docs.s3.amazonaws.com/vishal.rathore/face/face_background_remover_MzERcZdynEfGggqKtnWz/face_extract_1707307524537731.jpg?X-Amz-Algorithm=AWS4-",
        "face_crop": true
    },
    "status_code": 200,
    "success": true,
    "message": "Success",
    "message_code": "success"
}

Possible Error Responses

Authentication Error

Invalid Image

Processing Error

{
    "status_code": 401,
    "success": false,
    "message": "Unauthorized access",
    "message_code": "unauthorized"
}

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

Integration Best Practices

Security Recommendations

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

Implement token refresh mechanisms to handle token expiration

Validate the image on the client side before uploading to reduce unnecessary API calls

Use HTTPS for all API communications to ensure data security

User Experience Guidelines

Implement a loading indicator while the image is being processed

Provide clear feedback if the uploaded image doesn't contain a detectable face

Allow users to preview and approve the background-removed image before proceeding

Implement image size and format validation before uploading to improve success rates

Code Samples

cURL

Python

Node.js

Related APIs

Face Liveness Detection API: Verifies if a face in an image is from a live person

Face Matching API: Compares faces across different images to determine if they belong to the same person

Face Attributes API: Extracts facial attributes like age, gender, and emotions from facial images

Compliance and Legal Considerations

When implementing this API, ensure you have proper consent from individuals before processing their facial images. Many jurisdictions have specific regulations regarding biometric data processing, including facial images. Comply with relevant data protection regulations such as GDPR in Europe, CCPA in California, and other applicable privacy laws in your operating regions.

{ "data": { "client_id": "face_background_remover_MzERcZdynEfGggqKtnWz", "image_url": "https://aadhaar-kyc-docs.s3.amazonaws.com/vishal.rathore/face/face_background_remover_MzERcZdynEfGggqKtnWz/face_extract_1707307524537731.jpg?X-Amz-Algorithm=AWS4-" }, "face_crop": true, "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 ********************

Background Remover

Face Background Remover#

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