Package com.idanalyzer

Class Docupass

java.lang.Object

com.idanalyzer.Docupass

public class Docupass
extends Object

DocuPass remote verification & e-signature link management (/docupass).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Docupass.CreateRequest	Parameters for creating a Docupass link.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	createDocupass(Docupass.CreateRequest req)	Create a Docupass link (POST /docupass).
com.fasterxml.jackson.databind.JsonNode	deleteDocupass(String reference)	Delete a Docupass (DELETE /docupass/{reference}).
com.fasterxml.jackson.databind.JsonNode	getDocupass(String reference)	Retrieve a single Docupass (GET /docupass/{reference}).
com.fasterxml.jackson.databind.JsonNode	listDocupass(int order, int limit, int offset)	List Docupass records (GET /docupass).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

createDocupass

public com.fasterxml.jackson.databind.JsonNode createDocupass(Docupass.CreateRequest req)

Create a Docupass link (POST /docupass).

Parameters:

req - the link parameters; req.profile (KYC profile id) is required.

Returns:

the API response as a JsonNode.

Throws:

InvalidArgumentException - if req is null or its profile is null or empty.

ApiException - if the API returns an error or a transport error occurs.

listDocupass

public com.fasterxml.jackson.databind.JsonNode listDocupass(int order,
 int limit,
 int offset)

List Docupass records (GET /docupass).

Parameters:

order - sort order for the results.

limit - maximum number of records to return.

offset - number of records to skip (for pagination).

Returns:

the API response as a JsonNode.

Throws:

ApiException - if the API returns an error or a transport error occurs.

getDocupass

public com.fasterxml.jackson.databind.JsonNode getDocupass(String reference)

Retrieve a single Docupass (GET /docupass/{reference}).

Parameters:

reference - the Docupass reference to retrieve.

Returns:

the API response as a JsonNode.

Throws:

InvalidArgumentException - if reference is null or empty.

ApiException - if the API returns an error or a transport error occurs.

deleteDocupass

public com.fasterxml.jackson.databind.JsonNode deleteDocupass(String reference)

Delete a Docupass (DELETE /docupass/{reference}).

Parameters:

reference - the Docupass reference to delete.

Returns:

the API response as a JsonNode.

Throws:

InvalidArgumentException - if reference is null or empty.

ApiException - if the API returns an error or a transport error occurs.