API Reference
The CypherFace API is a RESTful service that uses JSON for request and response bodies. It requires authentication via JWT tokens after the user logs in. Below is the detailed documentation of various API endpoints, including registration, login and user management.
CypherFace API Environments
CypherFace provide two environment STAGING and PRODUCTION. Both environments are completely independent, meaning they do not share any information, including API credentials.
| Environment | Endpoint URL |
|---|---|
| Sandbox | https://staging.cypherface.com/ |
With these environments, you can effectively test your connection with CypherFace's APIs. For testing purposes, utilize the CypherFace Sandbox API, which allows you to explore features and functionality in a controlled setting.
Once you are ready to move to production, please reach out to your CypherFace point of contact for the live environment URL. This ensures that you have the correct credentials and access for seamless integration.
Authorization and API Keys
CypherFace uses API keys to authenticate requests. For the sandbox environment, we will provide you with a unique API key that allows you to test the API without real-world consequences.
When you're ready to go live, CypherFace will issue you a separate production API key. This key is specifically for use in the live environment and ensures secure access to all production-level features of the CypherFace API.
- Sandbox API Key: Use this key for testing and development in the sandbox environment.
- Production API Key: When ready for production, we will provide cypherFace production API key for secure live operations.
Both environments will require an authorization header in API requests, using the format Authorization: Bearer <API_Key>.
Proper management of your API keys is essential for securing your integration. For any further queries on obtaining your API keys or managing authorization, please contact our support team.
Authentication
The CypherFace API uses JWT (JSON Web Token) for authenticating requests after a user logs in. To perform operations on the platform (such as user management), you must authenticate your API calls with a valid JWT token.
Endpoints
Here is a detailed list of CypherFace API Endpoints, categorized by their functionality. This includes authentication, user management, and various operations such as email verification, face detection, and more.
CypherFace API Error Handling & Timeouts
Response Time: CypherFace API strives for quick response times, but certain processes (like image processing) can take longer. Ensure that client applications implement appropriate error handling for timeouts.
Timeout Limit: API requests may have a maximum timeout of 5 minutes for more complex tasks, such as face verification.
HTTP Status Codes
| HTTP Code | Meaning |
|---|---|
| 400 | Bad Request -- You provided a request that can't be successfully parsed. Verify you are providing valid JSON. |
| 401 | Unauthorized -- We could not authenticate your request. You used an incorrect API Key. |
| 402 | Upstream Processor Error -- Errors caused by 3rd party service. |
| 403 | Forbidden -- Your credentials don't have the right permissions to submit the request. |
| 404 | Not Found -- The specified resource could not be found. |
| 405 | Method Not Allowed -- The HTTP request method used to submit the request is not supported by the specified resource. |
| 406 | Not Acceptable -- The server can't accept the submitted request. Double-check how the request was formatted and submitted. |
| 409 | Conflict -- The submitted request conflicts with the current state of the server. |
| 422 | Unprocessable Entity -- The parameters were valid but the request failed. The error is usually some misunderstanding of various steps that have to be executed in order (e.g., attempting to initiate a transfer on behalf of a seller that has not yet been approved). |
| 500 | Internal Server Error -- We had a problem with our server. Try again later. |