Get Started Quickly

The Appruve API is built to be easy and developer-friendly. The following sections will walk you through the neccessary steps to get started verifying identities with the Appruve API.

Get Your Access Token

To access the Appruve API, you'll need a Personal Access Token, commonly referred as token in code samples. You can create and manage your Personal Access Tokens from your Appruve Dashboard.

Get Access Token

How To Authenticate

You can create either a Live Token or a Test Token. Use a Live Token to verify real user user IDs. A Test Token works with the sample user data used in the code samples below.

To use your token, simply provide it as part of the authorization header when you make a request. Tokens use the bearer authorization header when you make a request. This just means you need to specify the bearer type in the header.

                
  $ curl \
    -s https://api.appruve.co/verifications/773b72e3-35da-429f-bdbd-cf57a403c668 \
    -H 'Authorization: Bearer token' \
    -H 'Accept: application/json' \
                
              

Verify Ghana Passport ID Document

POST https://api.appruve.co/v1/verifications/gh/passport
    
$ curl -X POST \
  https://api.appruve.co/v1/verifications/gh/passport \
  -H 'Authorization: Bearer token' \
  -H 'Content-Type: application/json' \
  -d '{
        "id": "2233102035",
        "first_name": "John",
        "last_name": "Doe",
        "include_picture": true,
        "include_signature": true,
        "date_of_birth": "1986-04-05"
      }'
    
                    
    
{
  "id": "2233102035",
  "first_name": "John",
  "last_name": "Doe",
  "date_of_birth": "1986-04-05",
  "is_first_name_match": true,
  "is_last_name_match": true,
  "is_middle_name_match": false,
  "is_date_of_birth_match": true,
  "picture": "Base 64 Encoded String",
  "signature": "Base 64 Encoded String"
}
    
                    

Verify Ghana Voter ID Document

POST https://api.appruve.co/v1/verifications/gh/voter
    
$ curl -X POST \
  https://api.appruve.co/v1/verifications/gh/voter \
  -H 'Authorization: Bearer token' \
  -H 'Content-Type: application/json' \
  -d '{
        "id": "2233102035",
        "full_name": "John Doe",
        "include_picture": false
      }'
    
                    
    
{
  "id": "2233102035",
  "full_name": "John Doe",
  "is_full_name_match": true,
  "is_date_of_birth_match": false
}
    
                    

Verify Ghana SSNIT ID Document

POST https://api.appruve.co/v1/verifications/gh/ssnit
    
$ curl -X POST \
  https://api.appruve.co/v1/verifications/gh/ssnit \
  -H 'Authorization: Bearer token' \
  -H 'Content-Type: application/json' \
  -d '{
        "id": "2233102035",
        "full_name": "John Doe",
        "include_picture": false
      }'
    
                      
    
{
  "id": "2233102035",
  "full_name": "John Doe",
  "is_full_name_match": true,
  "is_date_of_birth_match": false
}
    
                      

Verify Ghana Driver License Document

POST https://api.appruve.co/v1/verifications/gh/driver_license
    
$ curl -X POST \
    https://api.appruve.co/v1/verifications/gh/driver_license \
    -H 'Authorization: Bearer token' \
    -H 'Content-Type: application/json' \
    -d '{
      "id": "2233102035",
      "full_name": "John Doe",
      "date_of_birth": "1992-04-05",
      "include_picture": true
    }'
    
                        
    
{
  "id": "2233102035",
  "full_name": "John Doe",
  "date_of_birth": "1992-04-05",
  "is_full_name_match": true,
  "is_date_of_birth_match": true,
  "picture": "Base 64 Encoded String"
}
    
                        

Verify Ghana Tax Identification Number

POST https://api.appruve.co/v1/verifications/gh/tin
    
$ curl -X POST \
  https://api.appruve.co/v1/verifications/gh/tin \
  -H 'Authorization: Bearer token' \
  -H 'Content-Type: application/json' \
  -d '{
        "tin": "C0000000002"
      }'
    
                        
    
{
  "tin": "C0000000002",
  "taxpayer_name": "JOHN DOE TECHNOLOGIES LIMITED",
  "tax_office": "RGD - OFFICE",
  "registration_status": "REGISTERED"
}