Skip to main content

Documentation

Verify Identity

Verify the identity of an individual or a personal contact for a person wallet.

The response to this request returns only the Rapyd ID and merchant reference ID that correspond to the identity verification request. The actual results of the identity check appear in a webhook. See:

Related Information
    • .NET

      • using System;
        using System.Text.Json;
        
        namespace RapydApiRequestSample
        {
            class Program
            {
                static void Main(string[] args)
                {
                    try
                    {
                        var requestObj = new
                        {
                            back_side_image = "",
                            back_side_image_mime_type = "",
                            country = "US",
                            document_type = "PA",
                            ewallet = "ewallet_b26a0b128d9f3e3a53a142b7d411c9d5",
                            face_image = "/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAkGBk=",
                            face_image_mime_type = "image/jpeg",
                            front_side_image = "/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAkGk=",
                            front_side_image_mime_type = "image/jpeg",
                            reference_id = "123success",
                            request_type = "store",
                            send_callback = (string) null,
                        };
        
                        string request = JsonSerializer.Serialize(requestObj);
        
                        string result = RapydApiRequestSample.Utilities.MakeRequest("POST", "/v1/identities", request);
        
                        Console.WriteLine(result);
                    }
                    catch (Exception e)
                    {
                        Console.WriteLine("Error completing request: " + e.Message);
                    }
                }
            }
        }
    • JavaScript

      • const makeRequest = require('<path-to-your-utility-file>/utilities').makeRequest;
        
        async function main() {
          try {
            const body = {
              back_side_image: '',
              back_side_image_mime_type: '',
              country: 'US',
              document_type: 'PA',
              ewallet: 'ewallet_b26a0b128d9f3e3a53a142b7d411c9d5',
              face_image: '/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAkGBk=',
              face_image_mime_type: 'image/jpeg',
              front_side_image: '/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAkGk=',
              front_side_image_mime_type: 'image/jpeg',
              reference_id: '123success',
              request_type: 'store',
              send_callback: null
            };
            const result = await makeRequest('POST', '/v1/identities', body);
        
            console.log(result);
          } catch (error) {
            console.error('Error completing request', error);
          }
        }
    • PHP

      • <?php
        $path = $_SERVER['DOCUMENT_ROOT'];
        $path .= "/<path-to-your-utility-file>/utilities.php";
        include($path);
        end_callback": null
        
        $body = [
            'back_side_image' => '',
            'back_side_image_mime_type' => '',
            'country' => 'US',
            'document_type' => 'PA',
            'ewallet' => 'ewallet_b26a0b128d9f3e3a53a142b7d411c9d5',
            'face_image' => '/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAkGBk=',
            'face_image_mime_type' => 'image/jpeg',
            'front_side_image' => '/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAkGk=',
            'front_side_image_mime_type' => 'image/jpeg',
            'reference_id' => '123success',
            'request_type' => 'store',
            'send_callback' => null
        ];
        
        try {
            $object = make_request('post', '/v1/identities', $body);
            var_dump($object);
        } catch(Exception $e) {
            echo "Error: $e";
        }
        ?>
    • Python

      • from pprint import pprint
        
        from utilities import make_request
        
        idv_details = {
            "back_side_image": "",
            "back_side_image_mime_type": "",
            "country": "US",
            "document_type": "PA",
            "ewallet": 'ewallet_b26a0b128d9f3e3a53a142b7d411c9d5',
            "face_image": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAkGBk=",
            "face_image_mime_type": "image/jpeg",
            "front_side_image": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAkGk=",
            "front_side_image_mime_type": "image/jpeg",
            "reference_id": "123success",
            "request_type": "store",
            "send_callback": None
        }
        
        results = make_request(method='post', path=f'/v1/identities', body=idv_details)
        pprint(results)
  • /v1/identities

  • Verify Identity

  • curl -X post
    https://sandboxapi.rapyd.net/v1/identities
    -H 'access_key: your-access-key-here'
    -H 'Content-Type: application/json'
    -H 'idempotency: your-idempotency-parameter-here'
    -H 'salt: your-random-string-here'
    -H 'signature: your-calculated-signature-here'
    -H 'timestamp: your-unix-timestamp-here'
    -d '
    // Note: Due to their excessive length, the values of `front_side_image` and `face_image` have been truncated.
    {
        "country": "US",
        "document_type": "PA",
        "ewallet": "ewallet_b26a0b128d9f3e3a53a142b7d411c9d5",
        "face_image": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAkGBk=",
        "face_image_mime_type": "image/jpeg",
        "front_side_image": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAkGk=",
        "front_side_image_mime_type": "image/jpeg",
        "reference_id": "123success"
    }
    '
    
  • "status": {
    		"error_code": "",
    		"status": "SUCCESS",
    		"message": "",
    		"response_code": "",
    		"operation_id": "9141a78a-6c62-4246-b628-6ea91164fd58"
    	},
    	"data": {
    		"id": "kycid_20142ac8ab4aa37f0a3d715456237f50",
    		"reference_id": "123success"
    	}
    }
  • Verify Identity with Contact

  • curl -X post
    https://sandboxapi.rapyd.net/v1/identities
    -H 'access_key: your-access-key-here'
    -H 'Content-Type: application/json'
    -H 'idempotency: your-idempotency-parameter-here'
    -H 'salt: your-random-string-here'
    -H 'signature: your-calculated-signature-here'
    -H 'timestamp: your-unix-timestamp-here'
    -d '
    // Note: Due to their excessive length, the values of `front_side_image` and `face_image` have been truncated.
    {
        "contact": "cont_dce548eacef85dec8722af757941dcf9",
        "country": "US",
        "document_type": "PA",
        "ewallet": "ewallet_f905e983a86bc343b29487cabfdd6849",
        "front_side_image": "/9j/4AAQSkZJRgABAQAAAQABAAD/2w=",
        "front_side_image_mime_type": "image/jpeg",
        "face_image": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAkG=",
        "face_image_mime_type": "image/jpeg",
        "reference_id": "55577-success2022"
    }
    '
    
  • {
    	"status": {
    		"error_code": "",
    		"status": "SUCCESS",
    		"message": "",
    		"response_code": "",
    		"operation_id": "48340f2a-5212-41a2-85d5-0d2b982bb80e"
    	},
    	"data": {
    		"id": "kycid_087a516335f950b29c2bccd47f011b48",
    		"reference_id": "55577-success2022"
    	}
    }