PIP - Physical Identity Proofing - API

API and SDK Documentation

Version: 1.0.0

This API will give you access to the Physical Identity Proofing (PIP) service from Mobai. Delivered at you post office. Contact Mobai at https://mobai.bio if you need access.

⚠️ Experimental Features

Webhook endpoints are currently in experimentation phase. While we strive for stability, breaking changes may occur during the experimentation period.

Webhook Security

All webhook requests are signed using JSON Web Tokens (JWT) with RSA-256 to ensure authenticity and integrity.

Verifying Webhook Signatures

Each webhook request includes an X-Webhook-JWT header containing a signed JWT:

X-Webhook-JWT: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IndlYmhvb2stMjAyNS0wMSJ9...

The JWT payload contains only the issuer and request body hash for verification purposes. All webhook event data is contained in the request body.

To verify the webhook:

Fetch the public key from our JWKS endpoint: /.well-known/jwks.json
Verify the JWT signature using the RSA public key
Compute SHA-256 hash of the request body and compare with body_sha256 claim
Process the webhook event data from the request body

JWT Payload

{
  "iss": "https://api.pip.mobai.cloud",
  "body_sha256": "29af93472705acb7c03ed14e9071bc31611ea5e8f6c2713713c1dc225eaca2b9"
}

Example Request Body

{
  "id": "0197b04a-d59d-78d2-a063-629943129c98",
  "timestamp": "2025-06-27T07:29:45.123456789Z",
  "type": "PIP_COMPLETED",
  "data": {
    "pipId": "0197b049-edec-743b-9259-b70e55ea8761",
    "pipStatus": "AWAITING_DOWNLOAD",
    "completedAt": "2025-06-27T07:29:43.835111Z"
  }
}

Example Implementation (Java)

import com.auth0.jwt.JWT;
import com.auth0.jwt.algorithms.Algorithm;
import com.auth0.jwt.interfaces.DecodedJWT;
import java.security.MessageDigest;
import java.util.Base64;

public void verifyWebhook(String jwtToken, String requestBody, RSAPublicKey publicKey) throws Exception {
// Verify JWT signature
Algorithm algorithm = Algorithm.RSA256(publicKey);
DecodedJWT jwt = JWT.require(algorithm)
.withIssuer("https://api.pip.mobai.cloud")
.build()
.verify(jwtToken);

// Verify request body integrity
MessageDigest digest = MessageDigest.getInstance("SHA-256");
byte[] hash = digest.digest(requestBody.getBytes("UTF-8"));
String computedHash = bytesToHex(hash);

String expectedHash = jwt.getClaim("body_sha256").asString();
if (!computedHash.equals(expectedHash)) {
throw new SecurityException("Request body hash mismatch");
}

// Process the webhook data from request body
// Parse requestBody JSON to extract event data
}

private String bytesToHex(byte[] bytes) {
StringBuilder result = new StringBuilder();
for (byte b : bytes) {
result.append(String.format("%02x", b));
}
return result.toString();
}

Webhook Headers

Each webhook request includes these headers:

Content-Type: application/json
X-Webhook-JWT: <jwt_token> - Signed JWT for verification

Public Key Discovery

Public keys for JWT verification are available at:

JWKS Endpoint: /.well-known/jwks.json
OpenID Configuration: /.well-known/openid-configuration

The JWT contains only verification data (iss and body_sha256). All webhook event data is provided in the request body for easy processing.

Authentication

authenticateCustomer

Authenticate customer

Verifies if the customer is authenticated

/v1/requestor/auth

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
\
-H "Accept: application/json"\
"https://api.pip.mobai.cloud/v1/requestor/auth"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AuthenticationApi;

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

public class AuthenticationApiExample {

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


        // Configure OAuth2 access token for authorization: oauth
        OAuth oauth = (OAuth) defaultClient.getAuthentication("oauth");
        oauth.setAccessToken("YOUR ACCESS TOKEN");

        AuthenticationApi apiInstance = new AuthenticationApi();
        try {
            apiInstance.authenticateCustomer();
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthenticationApi#authenticateCustomer");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.AuthenticationApi;

public class AuthenticationApiExample {

    public static void main(String[] args) {
        AuthenticationApi apiInstance = new AuthenticationApi();
        try {
            apiInstance.authenticateCustomer();
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthenticationApi#authenticateCustomer");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

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

// Authenticate customer
[apiInstance authenticateCustomerWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var PipPhysicalIdentityProofingApi = require('pip___physical_identity_proofing___api');
var defaultClient = PipPhysicalIdentityProofingApi.ApiClient.instance;


// Configure OAuth2 access token for authorization: oauth
var oauth = defaultClient.authentications['oauth'];
oauth.accessToken = "YOUR ACCESS TOKEN"

var api = new PipPhysicalIdentityProofingApi.AuthenticationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.authenticateCustomer(callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AuthenticationApi();

            try
            {
                // Authenticate customer
                apiInstance.authenticateCustomer();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthenticationApi.authenticateCustomer: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiAuthenticationApi();

try {
    $api_instance->authenticateCustomer();
} catch (Exception $e) {
    echo 'Exception when calling AuthenticationApi->authenticateCustomer: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AuthenticationApi;

# Configure OAuth2 access token for authorization: oauth
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::AuthenticationApi->new();

eval { 
    $api_instance->authenticateCustomer();
};
if ($@) {
    warn "Exception when calling AuthenticationApi->authenticateCustomer: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.AuthenticationApi()

try: 
    # Authenticate customer
    api_instance.authenticate_customer()
except ApiException as e:
    print("Exception when calling AuthenticationApi->authenticateCustomer: %s\n" % e)

Parameters

Responses

Status: 200 - Authentication successful

Status: 401 - Unauthorized - Missing or invalid API key

Schema

Status: 403 - Forbidden - User is authenticated but lacks privileges

Schema

PIPManagement

createPipRequest

Create new PIP request

Initiates a new Personal Identity Proofing request

/v1/requestor/pip

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://api.pip.mobai.cloud/v1/requestor/pip"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PIPManagementApi;

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

public class PIPManagementApiExample {

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


        // Configure OAuth2 access token for authorization: oauth
        OAuth oauth = (OAuth) defaultClient.getAuthentication("oauth");
        oauth.setAccessToken("YOUR ACCESS TOKEN");

        PIPManagementApi apiInstance = new PIPManagementApi();
        PipRequest body = ; // PipRequest | 
        try {
            PipResponse result = apiInstance.createPipRequest(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PIPManagementApi#createPipRequest");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.PIPManagementApi;

public class PIPManagementApiExample {

    public static void main(String[] args) {
        PIPManagementApi apiInstance = new PIPManagementApi();
        PipRequest body = ; // PipRequest | 
        try {
            PipResponse result = apiInstance.createPipRequest(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PIPManagementApi#createPipRequest");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
PipRequest *body = ; // 

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

// Create new PIP request
[apiInstance createPipRequestWith:body
              completionHandler: ^(PipResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var PipPhysicalIdentityProofingApi = require('pip___physical_identity_proofing___api');
var defaultClient = PipPhysicalIdentityProofingApi.ApiClient.instance;


// Configure OAuth2 access token for authorization: oauth
var oauth = defaultClient.authentications['oauth'];
oauth.accessToken = "YOUR ACCESS TOKEN"

var api = new PipPhysicalIdentityProofingApi.PIPManagementApi()
var body = ; // {{PipRequest}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createPipRequest(body, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PIPManagementApi();
            var body = new PipRequest(); // PipRequest | 

            try
            {
                // Create new PIP request
                PipResponse result = apiInstance.createPipRequest(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PIPManagementApi.createPipRequest: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPIPManagementApi();
$body = ; // PipRequest | 

try {
    $result = $api_instance->createPipRequest($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PIPManagementApi->createPipRequest: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PIPManagementApi;

# Configure OAuth2 access token for authorization: oauth
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PIPManagementApi->new();
my $body = WWW::SwaggerClient::Object::PipRequest->new(); # PipRequest | 

eval { 
    my $result = $api_instance->createPipRequest(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PIPManagementApi->createPipRequest: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PIPManagementApi()
body =  # PipRequest | 

try: 
    # Create new PIP request
    api_response = api_instance.create_pip_request(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PIPManagementApi->createPipRequest: %s\n" % e)

Parameters

Body parameters

Name	Description
body *

Responses

getPipRequestDetails

Get PIP request details

Retrieves details for a specific PIP request

/v1/requestor/pip/{pipId}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
\
-H "Accept: application/json"\
"https://api.pip.mobai.cloud/v1/requestor/pip/{pipId}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PIPManagementApi;

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

public class PIPManagementApiExample {

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


        // Configure OAuth2 access token for authorization: oauth
        OAuth oauth = (OAuth) defaultClient.getAuthentication("oauth");
        oauth.setAccessToken("YOUR ACCESS TOKEN");

        PIPManagementApi apiInstance = new PIPManagementApi();
        UUID pipId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | UUID of the PIP request
        try {
            PipResponse result = apiInstance.getPipRequestDetails(pipId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PIPManagementApi#getPipRequestDetails");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.PIPManagementApi;

public class PIPManagementApiExample {

    public static void main(String[] args) {
        PIPManagementApi apiInstance = new PIPManagementApi();
        UUID pipId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | UUID of the PIP request
        try {
            PipResponse result = apiInstance.getPipRequestDetails(pipId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PIPManagementApi#getPipRequestDetails");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
UUID *pipId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID of the PIP request

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

// Get PIP request details
[apiInstance getPipRequestDetailsWith:pipId
              completionHandler: ^(PipResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var PipPhysicalIdentityProofingApi = require('pip___physical_identity_proofing___api');
var defaultClient = PipPhysicalIdentityProofingApi.ApiClient.instance;


// Configure OAuth2 access token for authorization: oauth
var oauth = defaultClient.authentications['oauth'];
oauth.accessToken = "YOUR ACCESS TOKEN"

var api = new PipPhysicalIdentityProofingApi.PIPManagementApi()
var pipId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} UUID of the PIP request

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPipRequestDetails(pipId, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PIPManagementApi();
            var pipId = new UUID(); // UUID | UUID of the PIP request

            try
            {
                // Get PIP request details
                PipResponse result = apiInstance.getPipRequestDetails(pipId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PIPManagementApi.getPipRequestDetails: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPIPManagementApi();
$pipId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | UUID of the PIP request

try {
    $result = $api_instance->getPipRequestDetails($pipId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PIPManagementApi->getPipRequestDetails: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PIPManagementApi;

# Configure OAuth2 access token for authorization: oauth
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PIPManagementApi->new();
my $pipId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | UUID of the PIP request

eval { 
    my $result = $api_instance->getPipRequestDetails(pipId => $pipId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PIPManagementApi->getPipRequestDetails: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PIPManagementApi()
pipId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | UUID of the PIP request

try: 
    # Get PIP request details
    api_response = api_instance.get_pip_request_details(pipId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PIPManagementApi->getPipRequestDetails: %s\n" % e)

Parameters

Path parameters

Name	Description
pipId*	UUID (uuid) UUID of the PIP request Required

Responses

Status: 200 - PIP request details retrieved successfully

Schema

Status: 400 - Bad Request - Invalid UUID format

Schema

Status: 401 - Unauthorized - Missing or invalid API key

Schema

Status: 403 - Forbidden - User is authenticated but lacks privileges

Schema

Status: 404 - Not Found - PIP request doesn't exist or doesn't belong to the customer

Schema

listPipRequests

List all PIP requests

Retrieves PIP requests for the authenticated customer, with optional filtering by update time

/v1/requestor/pip

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
\
-H "Accept: application/json"\
"https://api.pip.mobai.cloud/v1/requestor/pip?updatedAfter="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PIPManagementApi;

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

public class PIPManagementApiExample {

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


        // Configure OAuth2 access token for authorization: oauth
        OAuth oauth = (OAuth) defaultClient.getAuthentication("oauth");
        oauth.setAccessToken("YOUR ACCESS TOKEN");

        PIPManagementApi apiInstance = new PIPManagementApi();
        Date updatedAfter = 2013-10-20T19:20:30+01:00; // Date | Filter PIPs to only those updated after this timestamp (ISO-8601 format)
        try {
            PipListResponse result = apiInstance.listPipRequests(updatedAfter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PIPManagementApi#listPipRequests");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.PIPManagementApi;

public class PIPManagementApiExample {

    public static void main(String[] args) {
        PIPManagementApi apiInstance = new PIPManagementApi();
        Date updatedAfter = 2013-10-20T19:20:30+01:00; // Date | Filter PIPs to only those updated after this timestamp (ISO-8601 format)
        try {
            PipListResponse result = apiInstance.listPipRequests(updatedAfter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PIPManagementApi#listPipRequests");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
Date *updatedAfter = 2013-10-20T19:20:30+01:00; // Filter PIPs to only those updated after this timestamp (ISO-8601 format) (optional)

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

// List all PIP requests
[apiInstance listPipRequestsWith:updatedAfter
              completionHandler: ^(PipListResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var PipPhysicalIdentityProofingApi = require('pip___physical_identity_proofing___api');
var defaultClient = PipPhysicalIdentityProofingApi.ApiClient.instance;


// Configure OAuth2 access token for authorization: oauth
var oauth = defaultClient.authentications['oauth'];
oauth.accessToken = "YOUR ACCESS TOKEN"

var api = new PipPhysicalIdentityProofingApi.PIPManagementApi()
var opts = { 
  'updatedAfter': 2013-10-20T19:20:30+01:00 // {{Date}} Filter PIPs to only those updated after this timestamp (ISO-8601 format)
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listPipRequests(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PIPManagementApi();
            var updatedAfter = 2013-10-20T19:20:30+01:00;  // Date | Filter PIPs to only those updated after this timestamp (ISO-8601 format) (optional) 

            try
            {
                // List all PIP requests
                PipListResponse result = apiInstance.listPipRequests(updatedAfter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PIPManagementApi.listPipRequests: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPIPManagementApi();
$updatedAfter = 2013-10-20T19:20:30+01:00; // Date | Filter PIPs to only those updated after this timestamp (ISO-8601 format)

try {
    $result = $api_instance->listPipRequests($updatedAfter);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PIPManagementApi->listPipRequests: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PIPManagementApi;

# Configure OAuth2 access token for authorization: oauth
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PIPManagementApi->new();
my $updatedAfter = 2013-10-20T19:20:30+01:00; # Date | Filter PIPs to only those updated after this timestamp (ISO-8601 format)

eval { 
    my $result = $api_instance->listPipRequests(updatedAfter => $updatedAfter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PIPManagementApi->listPipRequests: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PIPManagementApi()
updatedAfter = 2013-10-20T19:20:30+01:00 # Date | Filter PIPs to only those updated after this timestamp (ISO-8601 format) (optional)

try: 
    # List all PIP requests
    api_response = api_instance.list_pip_requests(updatedAfter=updatedAfter)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PIPManagementApi->listPipRequests: %s\n" % e)

Parameters

Query parameters

Name	Description
updatedAfter	Date (date-time) Filter PIPs to only those updated after this timestamp (ISO-8601 format)

Responses

Status: 200 - List of PIP requests retrieved successfully (limited to 1000 entries)

Schema

Status: 400 - Bad request

Schema

Status: 401 - Unauthorized - Missing or invalid API key

Schema

Status: 403 - Forbidden - User is authenticated but lacks CUSTOMER privileges

Schema

PIPResults

downloadPipResultFile

Download PIP results file.

Downloads the individual files from the report. Not available for customers that only receive by Digipost.

/v1/requestor/pip/{pipId}/result/{file}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
\
-H "Accept: application/pdf,image/jpeg,application/json"\
"https://api.pip.mobai.cloud/v1/requestor/pip/{pipId}/result/{file}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PIPResultsApi;

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

public class PIPResultsApiExample {

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


        // Configure OAuth2 access token for authorization: oauth
        OAuth oauth = (OAuth) defaultClient.getAuthentication("oauth");
        oauth.setAccessToken("YOUR ACCESS TOKEN");

        PIPResultsApi apiInstance = new PIPResultsApi();
        UUID pipId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | UUID of the PIP request
        String file = file_example; // String | File to be downloaded
        try {
            byte[] result = apiInstance.downloadPipResultFile(pipId, file);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PIPResultsApi#downloadPipResultFile");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.PIPResultsApi;

public class PIPResultsApiExample {

    public static void main(String[] args) {
        PIPResultsApi apiInstance = new PIPResultsApi();
        UUID pipId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | UUID of the PIP request
        String file = file_example; // String | File to be downloaded
        try {
            byte[] result = apiInstance.downloadPipResultFile(pipId, file);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PIPResultsApi#downloadPipResultFile");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
UUID *pipId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID of the PIP request
String *file = file_example; // File to be downloaded

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

// Download PIP results file.
[apiInstance downloadPipResultFileWith:pipId
    file:file
              completionHandler: ^(byte[] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var PipPhysicalIdentityProofingApi = require('pip___physical_identity_proofing___api');
var defaultClient = PipPhysicalIdentityProofingApi.ApiClient.instance;


// Configure OAuth2 access token for authorization: oauth
var oauth = defaultClient.authentications['oauth'];
oauth.accessToken = "YOUR ACCESS TOKEN"

var api = new PipPhysicalIdentityProofingApi.PIPResultsApi()
var pipId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} UUID of the PIP request
var file = file_example; // {{String}} File to be downloaded

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.downloadPipResultFile(pipId, file, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PIPResultsApi();
            var pipId = new UUID(); // UUID | UUID of the PIP request
            var file = file_example;  // String | File to be downloaded

            try
            {
                // Download PIP results file.
                byte[] result = apiInstance.downloadPipResultFile(pipId, file);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PIPResultsApi.downloadPipResultFile: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPIPResultsApi();
$pipId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | UUID of the PIP request
$file = file_example; // String | File to be downloaded

try {
    $result = $api_instance->downloadPipResultFile($pipId, $file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PIPResultsApi->downloadPipResultFile: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PIPResultsApi;

# Configure OAuth2 access token for authorization: oauth
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PIPResultsApi->new();
my $pipId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | UUID of the PIP request
my $file = file_example; # String | File to be downloaded

eval { 
    my $result = $api_instance->downloadPipResultFile(pipId => $pipId, file => $file);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PIPResultsApi->downloadPipResultFile: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PIPResultsApi()
pipId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | UUID of the PIP request
file = file_example # String | File to be downloaded

try: 
    # Download PIP results file.
    api_response = api_instance.download_pip_result_file(pipId, file)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PIPResultsApi->downloadPipResultFile: %s\n" % e)

Parameters

Path parameters

Name	Description
pipId*	UUID (uuid) UUID of the PIP request Required
file*	String File to be downloaded Required

Responses

Status: 200 - PIP result file downloaded successfully

Schema

Status: 400 - Bad Request - Invalid file

Schema

Status: 401 - Unauthorized - Missing or invalid API key

Schema

Status: 403 - Forbidden - User is authenticated but lacks privileges

Schema

Status: 404 - Not Found - PIP request doesn't exist, doesn't belong to the customer, has no results, or is in CREATED status

Schema

downloadPipResults

Download PIP results

Downloads the results of a completed PIP request either as JSON or as a ZIP file containing PDF report, XML data, and chip image. Not available for customers that only use Digipost for download

/v1/requestor/pip/{pipId}/result

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
\
-H "Accept: application/json,application/zip"\
"https://api.pip.mobai.cloud/v1/requestor/pip/{pipId}/result"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PIPResultsApi;

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

public class PIPResultsApiExample {

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


        // Configure OAuth2 access token for authorization: oauth
        OAuth oauth = (OAuth) defaultClient.getAuthentication("oauth");
        oauth.setAccessToken("YOUR ACCESS TOKEN");

        PIPResultsApi apiInstance = new PIPResultsApi();
        UUID pipId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | UUID of the PIP request
        String accept = accept_example; // String | The desired content type (application/json or application/zip)
        try {
            PipResultResponse result = apiInstance.downloadPipResults(pipId, accept);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PIPResultsApi#downloadPipResults");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.PIPResultsApi;

public class PIPResultsApiExample {

    public static void main(String[] args) {
        PIPResultsApi apiInstance = new PIPResultsApi();
        UUID pipId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | UUID of the PIP request
        String accept = accept_example; // String | The desired content type (application/json or application/zip)
        try {
            PipResultResponse result = apiInstance.downloadPipResults(pipId, accept);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PIPResultsApi#downloadPipResults");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
UUID *pipId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID of the PIP request
String *accept = accept_example; // The desired content type (application/json or application/zip) (optional) (default to application/json)

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

// Download PIP results
[apiInstance downloadPipResultsWith:pipId
    accept:accept
              completionHandler: ^(PipResultResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var PipPhysicalIdentityProofingApi = require('pip___physical_identity_proofing___api');
var defaultClient = PipPhysicalIdentityProofingApi.ApiClient.instance;


// Configure OAuth2 access token for authorization: oauth
var oauth = defaultClient.authentications['oauth'];
oauth.accessToken = "YOUR ACCESS TOKEN"

var api = new PipPhysicalIdentityProofingApi.PIPResultsApi()
var pipId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} UUID of the PIP request
var opts = { 
  'accept': accept_example // {{String}} The desired content type (application/json or application/zip)
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.downloadPipResults(pipId, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PIPResultsApi();
            var pipId = new UUID(); // UUID | UUID of the PIP request
            var accept = accept_example;  // String | The desired content type (application/json or application/zip) (optional)  (default to application/json)

            try
            {
                // Download PIP results
                PipResultResponse result = apiInstance.downloadPipResults(pipId, accept);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PIPResultsApi.downloadPipResults: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPIPResultsApi();
$pipId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | UUID of the PIP request
$accept = accept_example; // String | The desired content type (application/json or application/zip)

try {
    $result = $api_instance->downloadPipResults($pipId, $accept);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PIPResultsApi->downloadPipResults: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PIPResultsApi;

# Configure OAuth2 access token for authorization: oauth
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PIPResultsApi->new();
my $pipId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | UUID of the PIP request
my $accept = accept_example; # String | The desired content type (application/json or application/zip)

eval { 
    my $result = $api_instance->downloadPipResults(pipId => $pipId, accept => $accept);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PIPResultsApi->downloadPipResults: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PIPResultsApi()
pipId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | UUID of the PIP request
accept = accept_example # String | The desired content type (application/json or application/zip) (optional) (default to application/json)

try: 
    # Download PIP results
    api_response = api_instance.download_pip_results(pipId, accept=accept)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PIPResultsApi->downloadPipResults: %s\n" % e)

Parameters

Path parameters

Name	Description
pipId*	UUID (uuid) UUID of the PIP request Required

Header parameters

Name	Description
Accept	String The desired content type (application/json or application/zip)

Responses

Status: 200 - PIP results downloaded successfully

Schema
Headers

Name	Type	Format	Description
Content-Disposition	String		Attachment filename in the format "result-CODE-UUID.zip"

Status: 400 - Bad Request - Invalid UUID format

Schema

Status: 401 - Unauthorized - Missing or invalid API key

Schema

Status: 403 - Forbidden - User is authenticated but lacks privileges

Schema

Status: 404 - Not Found - PIP request doesn't exist, doesn't belong to the customer, has no results, or is in CREATED status

Schema

PIPTESTCREATEFAKEDATA

finishPipWithFakeData

Finish a PIP with fake identity data - This endpoint will only work in test/qa environments

Retrieves details for a specific PIP request

/v1/requestor/pip/{pipId}/finishPipWithFakeData

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://api.pip.mobai.cloud/v1/requestor/pip/{pipId}/finishPipWithFakeData"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PIPTESTCREATEFAKEDATAApi;

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

public class PIPTESTCREATEFAKEDATAApiExample {

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


        // Configure OAuth2 access token for authorization: oauth
        OAuth oauth = (OAuth) defaultClient.getAuthentication("oauth");
        oauth.setAccessToken("YOUR ACCESS TOKEN");

        PIPTESTCREATEFAKEDATAApi apiInstance = new PIPTESTCREATEFAKEDATAApi();
        PipFakeDataRequest body = ; // PipFakeDataRequest | 
        UUID pipId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | UUID of the PIP request
        try {
            apiInstance.finishPipWithFakeData(body, pipId);
        } catch (ApiException e) {
            System.err.println("Exception when calling PIPTESTCREATEFAKEDATAApi#finishPipWithFakeData");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.PIPTESTCREATEFAKEDATAApi;

public class PIPTESTCREATEFAKEDATAApiExample {

    public static void main(String[] args) {
        PIPTESTCREATEFAKEDATAApi apiInstance = new PIPTESTCREATEFAKEDATAApi();
        PipFakeDataRequest body = ; // PipFakeDataRequest | 
        UUID pipId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | UUID of the PIP request
        try {
            apiInstance.finishPipWithFakeData(body, pipId);
        } catch (ApiException e) {
            System.err.println("Exception when calling PIPTESTCREATEFAKEDATAApi#finishPipWithFakeData");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
PipFakeDataRequest *body = ; // 
UUID *pipId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID of the PIP request

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

// Finish a PIP with fake identity data - This endpoint will only work in test/qa environments
[apiInstance finishPipWithFakeDataWith:body
    pipId:pipId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var PipPhysicalIdentityProofingApi = require('pip___physical_identity_proofing___api');
var defaultClient = PipPhysicalIdentityProofingApi.ApiClient.instance;


// Configure OAuth2 access token for authorization: oauth
var oauth = defaultClient.authentications['oauth'];
oauth.accessToken = "YOUR ACCESS TOKEN"

var api = new PipPhysicalIdentityProofingApi.PIPTESTCREATEFAKEDATAApi()
var body = ; // {{PipFakeDataRequest}} 
var pipId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} UUID of the PIP request

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.finishPipWithFakeData(bodypipId, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PIPTESTCREATEFAKEDATAApi();
            var body = new PipFakeDataRequest(); // PipFakeDataRequest | 
            var pipId = new UUID(); // UUID | UUID of the PIP request

            try
            {
                // Finish a PIP with fake identity data - This endpoint will only work in test/qa environments
                apiInstance.finishPipWithFakeData(body, pipId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PIPTESTCREATEFAKEDATAApi.finishPipWithFakeData: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPIPTESTCREATEFAKEDATAApi();
$body = ; // PipFakeDataRequest | 
$pipId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | UUID of the PIP request

try {
    $api_instance->finishPipWithFakeData($body, $pipId);
} catch (Exception $e) {
    echo 'Exception when calling PIPTESTCREATEFAKEDATAApi->finishPipWithFakeData: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PIPTESTCREATEFAKEDATAApi;

# Configure OAuth2 access token for authorization: oauth
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PIPTESTCREATEFAKEDATAApi->new();
my $body = WWW::SwaggerClient::Object::PipFakeDataRequest->new(); # PipFakeDataRequest | 
my $pipId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | UUID of the PIP request

eval { 
    $api_instance->finishPipWithFakeData(body => $body, pipId => $pipId);
};
if ($@) {
    warn "Exception when calling PIPTESTCREATEFAKEDATAApi->finishPipWithFakeData: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PIPTESTCREATEFAKEDATAApi()
body =  # PipFakeDataRequest | 
pipId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | UUID of the PIP request

try: 
    # Finish a PIP with fake identity data - This endpoint will only work in test/qa environments
    api_instance.finish_pip_with_fake_data(body, pipId)
except ApiException as e:
    print("Exception when calling PIPTESTCREATEFAKEDATAApi->finishPipWithFakeData: %s\n" % e)

Parameters

Path parameters

Name	Description
pipId*	UUID (uuid) UUID of the PIP request Required

Body parameters

Name	Description
body *

Responses

Status: 200 - PIP successfully finished with fake data

Status: 400 - Bad Request - Invalid UUID format or expired/user pip

Schema

Status: 401 - Unauthorized - Missing or invalid API key

Schema

Status: 403 - Forbidden - User is authenticated but lacks privileges

Schema

Status: 404 - PIP not found or requestor does not own the PIP

Schema

WebhookManagement

deleteWebhookConfiguration

Delete webhook configuration

Removes the webhook configuration for the authenticated customer. No more webhook events will be sent.

/v1/requestor/webhook

Usage and SDK Samples

curl -X DELETE\
 -H "Authorization: Bearer [[accessToken]]"\
\
-H "Accept: application/json"\
"https://api.pip.mobai.cloud/v1/requestor/webhook"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WebhookManagementApi;

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

public class WebhookManagementApiExample {

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


        // Configure OAuth2 access token for authorization: oauth
        OAuth oauth = (OAuth) defaultClient.getAuthentication("oauth");
        oauth.setAccessToken("YOUR ACCESS TOKEN");

        WebhookManagementApi apiInstance = new WebhookManagementApi();
        try {
            apiInstance.deleteWebhookConfiguration();
        } catch (ApiException e) {
            System.err.println("Exception when calling WebhookManagementApi#deleteWebhookConfiguration");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.WebhookManagementApi;

public class WebhookManagementApiExample {

    public static void main(String[] args) {
        WebhookManagementApi apiInstance = new WebhookManagementApi();
        try {
            apiInstance.deleteWebhookConfiguration();
        } catch (ApiException e) {
            System.err.println("Exception when calling WebhookManagementApi#deleteWebhookConfiguration");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

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

// Delete webhook configuration
[apiInstance deleteWebhookConfigurationWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var PipPhysicalIdentityProofingApi = require('pip___physical_identity_proofing___api');
var defaultClient = PipPhysicalIdentityProofingApi.ApiClient.instance;


// Configure OAuth2 access token for authorization: oauth
var oauth = defaultClient.authentications['oauth'];
oauth.accessToken = "YOUR ACCESS TOKEN"

var api = new PipPhysicalIdentityProofingApi.WebhookManagementApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteWebhookConfiguration(callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new WebhookManagementApi();

            try
            {
                // Delete webhook configuration
                apiInstance.deleteWebhookConfiguration();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WebhookManagementApi.deleteWebhookConfiguration: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiWebhookManagementApi();

try {
    $api_instance->deleteWebhookConfiguration();
} catch (Exception $e) {
    echo 'Exception when calling WebhookManagementApi->deleteWebhookConfiguration: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::WebhookManagementApi;

# Configure OAuth2 access token for authorization: oauth
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::WebhookManagementApi->new();

eval { 
    $api_instance->deleteWebhookConfiguration();
};
if ($@) {
    warn "Exception when calling WebhookManagementApi->deleteWebhookConfiguration: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.WebhookManagementApi()

try: 
    # Delete webhook configuration
    api_instance.delete_webhook_configuration()
except ApiException as e:
    print("Exception when calling WebhookManagementApi->deleteWebhookConfiguration: %s\n" % e)

Parameters

Responses

Status: 204 - Webhook configuration deleted successfully

Status: 401 - Unauthorized - Missing or invalid API key

Schema

Status: 403 - Forbidden - Requestor not valid

Schema

getWebhookConfiguration

Get webhook configuration

Retrieves the current webhook configuration for the authenticated customer

/v1/requestor/webhook

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
\
-H "Accept: application/json"\
"https://api.pip.mobai.cloud/v1/requestor/webhook"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WebhookManagementApi;

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

public class WebhookManagementApiExample {

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


        // Configure OAuth2 access token for authorization: oauth
        OAuth oauth = (OAuth) defaultClient.getAuthentication("oauth");
        oauth.setAccessToken("YOUR ACCESS TOKEN");

        WebhookManagementApi apiInstance = new WebhookManagementApi();
        try {
            WebhookConfigurationResponse result = apiInstance.getWebhookConfiguration();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebhookManagementApi#getWebhookConfiguration");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.WebhookManagementApi;

public class WebhookManagementApiExample {

    public static void main(String[] args) {
        WebhookManagementApi apiInstance = new WebhookManagementApi();
        try {
            WebhookConfigurationResponse result = apiInstance.getWebhookConfiguration();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebhookManagementApi#getWebhookConfiguration");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

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

// Get webhook configuration
[apiInstance getWebhookConfigurationWithCompletionHandler: 
              ^(WebhookConfigurationResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var PipPhysicalIdentityProofingApi = require('pip___physical_identity_proofing___api');
var defaultClient = PipPhysicalIdentityProofingApi.ApiClient.instance;


// Configure OAuth2 access token for authorization: oauth
var oauth = defaultClient.authentications['oauth'];
oauth.accessToken = "YOUR ACCESS TOKEN"

var api = new PipPhysicalIdentityProofingApi.WebhookManagementApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getWebhookConfiguration(callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new WebhookManagementApi();

            try
            {
                // Get webhook configuration
                WebhookConfigurationResponse result = apiInstance.getWebhookConfiguration();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WebhookManagementApi.getWebhookConfiguration: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiWebhookManagementApi();

try {
    $result = $api_instance->getWebhookConfiguration();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WebhookManagementApi->getWebhookConfiguration: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::WebhookManagementApi;

# Configure OAuth2 access token for authorization: oauth
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::WebhookManagementApi->new();

eval { 
    my $result = $api_instance->getWebhookConfiguration();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WebhookManagementApi->getWebhookConfiguration: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.WebhookManagementApi()

try: 
    # Get webhook configuration
    api_response = api_instance.get_webhook_configuration()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WebhookManagementApi->getWebhookConfiguration: %s\n" % e)

Parameters

Responses

Status: 200 - Webhook configuration retrieved successfully

Schema

Status: 401 - Unauthorized - Missing or invalid API key

Schema

Status: 403 - Forbidden - Requestor not valid

Schema

setWebhookConfiguration

Set webhook configuration

Creates or updates the webhook configuration for the authenticated customer. Webhook events will be signed with JWT tokens that can be verified using our public key endpoint.

/v1/requestor/webhook

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
\
-H "Accept: application/json"\
"https://api.pip.mobai.cloud/v1/requestor/webhook?url="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WebhookManagementApi;

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

public class WebhookManagementApiExample {

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


        // Configure OAuth2 access token for authorization: oauth
        OAuth oauth = (OAuth) defaultClient.getAuthentication("oauth");
        oauth.setAccessToken("YOUR ACCESS TOKEN");

        WebhookManagementApi apiInstance = new WebhookManagementApi();
        String url = url_example; // String | HTTPS URL where webhook events will be sent
        try {
            apiInstance.setWebhookConfiguration(url);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebhookManagementApi#setWebhookConfiguration");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.WebhookManagementApi;

public class WebhookManagementApiExample {

    public static void main(String[] args) {
        WebhookManagementApi apiInstance = new WebhookManagementApi();
        String url = url_example; // String | HTTPS URL where webhook events will be sent
        try {
            apiInstance.setWebhookConfiguration(url);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebhookManagementApi#setWebhookConfiguration");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *url = url_example; // HTTPS URL where webhook events will be sent

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

// Set webhook configuration
[apiInstance setWebhookConfigurationWith:url
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var PipPhysicalIdentityProofingApi = require('pip___physical_identity_proofing___api');
var defaultClient = PipPhysicalIdentityProofingApi.ApiClient.instance;


// Configure OAuth2 access token for authorization: oauth
var oauth = defaultClient.authentications['oauth'];
oauth.accessToken = "YOUR ACCESS TOKEN"

var api = new PipPhysicalIdentityProofingApi.WebhookManagementApi()
var url = url_example; // {{String}} HTTPS URL where webhook events will be sent

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.setWebhookConfiguration(url, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            // Configure OAuth2 access token for authorization: oauth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new WebhookManagementApi();
            var url = url_example;  // String | HTTPS URL where webhook events will be sent

            try
            {
                // Set webhook configuration
                apiInstance.setWebhookConfiguration(url);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WebhookManagementApi.setWebhookConfiguration: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiWebhookManagementApi();
$url = url_example; // String | HTTPS URL where webhook events will be sent

try {
    $api_instance->setWebhookConfiguration($url);
} catch (Exception $e) {
    echo 'Exception when calling WebhookManagementApi->setWebhookConfiguration: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::WebhookManagementApi;

# Configure OAuth2 access token for authorization: oauth
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::WebhookManagementApi->new();
my $url = url_example; # String | HTTPS URL where webhook events will be sent

eval { 
    $api_instance->setWebhookConfiguration(url => $url);
};
if ($@) {
    warn "Exception when calling WebhookManagementApi->setWebhookConfiguration: $@\n";
}

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.WebhookManagementApi()
url = url_example # String | HTTPS URL where webhook events will be sent

try: 
    # Set webhook configuration
    api_instance.set_webhook_configuration(url)
except ApiException as e:
    print("Exception when calling WebhookManagementApi->setWebhookConfiguration: %s\n" % e)

Parameters

Query parameters

Name	Description
url*	String (uri) HTTPS URL where webhook events will be sent Required

PIP - Physical Identity Proofing - API

API and SDK Documentation

⚠️ Experimental Features

Webhook Security

Verifying Webhook Signatures

JWT Payload

Example Request Body

Example Implementation (Java)

Webhook Headers

Public Key Discovery

Authentication

authenticateCustomer

Usage and SDK Samples

Parameters

Responses

Status: 200 - Authentication successful

Status: 401 - Unauthorized - Missing or invalid API key

Status: 403 - Forbidden - User is authenticated but lacks privileges

PIPManagement

createPipRequest

Usage and SDK Samples

Parameters

Responses

Status: 200 - PIP request created successfully

Status: 401 - Unauthorized - Missing or invalid API key

Status: 403 - Forbidden - User is authenticated but lacks privileges

getPipRequestDetails

Usage and SDK Samples

Parameters

Responses

Status: 200 - PIP request details retrieved successfully

Status: 400 - Bad Request - Invalid UUID format

Status: 401 - Unauthorized - Missing or invalid API key

Status: 403 - Forbidden - User is authenticated but lacks privileges

Status: 404 - Not Found - PIP request doesn't exist or doesn't belong to the customer

listPipRequests

Usage and SDK Samples

Parameters

Responses

Status: 200 - List of PIP requests retrieved successfully (limited to 1000 entries)

Status: 400 - Bad request

Status: 401 - Unauthorized - Missing or invalid API key

Status: 403 - Forbidden - User is authenticated but lacks CUSTOMER privileges

PIPResults

downloadPipResultFile

Usage and SDK Samples

Parameters

Responses

Status: 200 - PIP result file downloaded successfully

Status: 400 - Bad Request - Invalid file

Status: 401 - Unauthorized - Missing or invalid API key

Status: 403 - Forbidden - User is authenticated but lacks privileges

Status: 404 - Not Found - PIP request doesn't exist, doesn't belong to the customer, has no results, or is in CREATED status

downloadPipResults

Usage and SDK Samples

Parameters

Responses

Status: 200 - PIP results downloaded successfully

Status: 400 - Bad Request - Invalid UUID format

Status: 401 - Unauthorized - Missing or invalid API key

Status: 403 - Forbidden - User is authenticated but lacks privileges

Status: 404 - Not Found - PIP request doesn't exist, doesn't belong to the customer, has no results, or is in CREATED status

PIPTESTCREATEFAKEDATA

finishPipWithFakeData

Usage and SDK Samples

Parameters

Responses

Status: 200 - PIP successfully finished with fake data

Status: 400 - Bad Request - Invalid UUID format or expired/user pip

Status: 401 - Unauthorized - Missing or invalid API key

Status: 403 - Forbidden - User is authenticated but lacks privileges

Status: 404 - PIP not found or requestor does not own the PIP

WebhookManagement

deleteWebhookConfiguration

Usage and SDK Samples

Parameters

Responses

Status: 204 - Webhook configuration deleted successfully

Status: 401 - Unauthorized - Missing or invalid API key

Status: 403 - Forbidden - Requestor not valid