BioVerify API

Default

v1VerifyPost

Collect documents and verify identity

Initiate the collection and verification of identity and other documents


/v1/verify

Usage and SDK Samples

curl -X POST -H "x-api-key: [[apiKey]]" "https://api.bioverify.app/v1/verify"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        DefaultApi apiInstance = new DefaultApi();
        String xApiKey = xApiKey_example; // String | The api key required to access the api
        VerificationRequest verificationRequest = ; // VerificationRequest | VerificationRequest
        try {
            VerificationResponse result = apiInstance.v1VerifyPost(xApiKey, verificationRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#v1VerifyPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String xApiKey = xApiKey_example; // String | The api key required to access the api
        VerificationRequest verificationRequest = ; // VerificationRequest | VerificationRequest
        try {
            VerificationResponse result = apiInstance.v1VerifyPost(xApiKey, verificationRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#v1VerifyPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];

String *xApiKey = xApiKey_example; // The api key required to access the api
VerificationRequest *verificationRequest = ; // VerificationRequest

DefaultApi *apiInstance = [[DefaultApi alloc] init];

// Collect documents and verify identity
[apiInstance v1VerifyPostWith:xApiKey
    verificationRequest:verificationRequest
              completionHandler: ^(VerificationResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var BioVerifyApi = require('bio_verify_api');
var defaultClient = BioVerifyApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token"

var api = new BioVerifyApi.DefaultApi()

var xApiKey = xApiKey_example; // {String} The api key required to access the api

var verificationRequest = ; // {VerificationRequest} VerificationRequest


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.v1VerifyPost(xApiKey, verificationRequest, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class v1VerifyPostExample
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            var apiInstance = new DefaultApi();
            var xApiKey = xApiKey_example;  // String | The api key required to access the api
            var verificationRequest = new VerificationRequest(); // VerificationRequest | VerificationRequest

            try
            {
                // Collect documents and verify identity
                VerificationResponse result = apiInstance.v1VerifyPost(xApiKey, verificationRequest);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.v1VerifyPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

$api_instance = new Swagger\Client\Api\DefaultApi();
$xApiKey = xApiKey_example; // String | The api key required to access the api
$verificationRequest = ; // VerificationRequest | VerificationRequest

try {
    $result = $api_instance->v1VerifyPost($xApiKey, $verificationRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->v1VerifyPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $xApiKey = xApiKey_example; # String | The api key required to access the api
my $verificationRequest = WWW::SwaggerClient::Object::VerificationRequest->new(); # VerificationRequest | VerificationRequest

eval {
    my $result = $api_instance->v1VerifyPost(xApiKey => $xApiKey, verificationRequest => $verificationRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->v1VerifyPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
swagger_client.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.DefaultApi()
xApiKey = xApiKey_example # String | The api key required to access the api
verificationRequest =  # VerificationRequest | VerificationRequest

try:
    # Collect documents and verify identity
    api_response = api_instance.v1_verify_post(xApiKey, verificationRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->v1VerifyPost: %s\n" % e)

Parameters

Header parameters
Name Description
x-api-key*
String
The api key required to access the api
Required
Body parameters
Name Description
verificationRequest *

Responses

Status: 200 - 200 response

Status: 400 - 400 response

Status: 401 - 401 response

Status: 403 - 403 response

Status: 404 - 404 response

Status: 422 - 422 response

Status: 500 - 500 response

Status: 502 - 502 response

Status: 504 - 504 response