Skip to content

SourceID API Overview

Welcome to the SourceID API documentation! The SourceID API provides a powerful and flexible way to integrate identity and access management capabilities into your applications. With SourceID, you can securely verify users and manage identities with ease.

Key Features

  • Authentication: Implement secure user verification using industry-standard protocols.
  • Identity Management: Group and customize verification types to suit your application's needs, giving you full control over how user verifications are structured and managed.
  • Scalability: Designed to handle high volumes of requests, ensuring reliability for applications of any size.
  • Developer-Friendly: Comprehensive API endpoints with detailed documentation to simplify integration.

Base URL

The SourceID API is available in two environments:

  • Sandbox: Use the following base URL for testing and development purposes:
    https://api.sbx.sourceid.tech

  • Production: The production URL will be provided by the support team. The API will be accessible at a URL similar to:
    https://api.sourceid.tech

Please ensure you are using the correct environment for your use case.

Sandbox Test Parameters

When testing the API in sandbox mode, you can use the following test parameters to simulate different response scenarios. These parameters are specifically designed for testing purposes and will return predictable responses.

Test Values for Different Scenarios

Testing Tip

For Duplicate references use this value 77777777777.

Parameter Type Valid Test Value Invalid Test Value Error Test Value Face Mismatch Value
BVN 12345678901 00000000000 99999999999 88888888888
NIN 12345678901 00000000000 99999999999 88888888888
EMAIL [email protected] [email protected] [email protected]
PHONE 08012345678 00000000000 99999999999
TIN 12345678-00001 00000000-00000 99999999-99999
PASSPORT A00400000 B00000000 C99999999
RC_NUMBER RC123456 RC000000 RC999999
GHANA_CARD GHA123456789 GHA000000000 GHA999999999
ALIEN_ID ALN123456789 ALN000000000 ALN999999999
DRIVERS_LICENSE DL123456789 DL000000000 DL999999999
NATIONAL_ID NID123456789 NID000000000 NID999999999

Response Behavior

  • Valid Test Values: Will return a successful response with mock data
  • Invalid Test Values: Will return a validation error response
  • Error Test Values: Will simulate a server error response

Testing Tip

Use these test values during development to ensure your application handles all possible API response scenarios correctly.

API Response Codes

This document provides a detailed description of the response codes used in the system. These codes indicate the status of a request and help identify issues when they occur.

✅ Success Codes

Code Description
00 SUCCESS: The request was successfully processed.

❌ Failure/Error Codes

Code Description
99 FAILED: The request failed due to an unspecified error.
91 INVALID_REQUEST: The request was malformed or contained invalid data.
92 INVALID_CREDENTIALS: Authentication failed due to incorrect credentials.
94 TIMEOUT: The request timed out due to no response within the expected time frame.
95 PROVIDER_ERROR: An error occurred from an external provider or service.
96 INVALID_DOCUMENT: The submitted document was invalid or unreadable.
97 DOCUMENT_EXPIRED: The document provided has expired.
98 DOCUMENT_NOT_FOUND: The specified document could not be located.
90 FACE_MISMATCH: Face verification failed; faces did not match.
100 INVALID_IMAGE: The image provided was invalid or not suitable for processing.
101 SYSTEM_ERROR: An internal system error occurred.
102 SERVICE_TEMPORARILY_UNAVAILABLE: The service is currently unavailable, try again later.
103 DUPLICATE_REFERENCE: The reference used already exists and must be unique.

⏳ Pending Code

Code Description
03 PENDING: The request is being processed and not yet complete.

Note: Always refer to the specific error code for appropriate handling logic and user feedback.

Authentication

The SourceID API uses token-based authentication. You will need to include an access token in the x-api-key header of each request:

x-api-key: {API-KEY}

Getting Started

  1. Sign Up: Register for a SourceID account to obtain your API credentials.
  2. Obtain API KEY: Use your credentials to authenticate your API request.
  3. Explore Endpoints: Use the API to verify users.

Example Request

Here’s an example of a simple API request to fetch user details:

GET /v1/customer
Host: api.rd.sourceid.tech
x-api-key: {API-KEY}

Support

If you have any questions or need assistance, please contact our support team or refer to the detailed endpoint documentation.

Start building with the SourceID API today and unlock seamless identity and access management for your applications!