boldsign.IdentityVerificationApi

All URIs are relative to https://api.boldsign.com

Method	HTTP request	Description
create_embedded_verification_url	POST /v1/identityVerification/createEmbeddedVerificationUrl	Generate a URL that embeds manual ID verification for the specified document signer into your application.
image	POST /v1/identityVerification/image	Retrieve the uploaded ID verification document or selfie image for the specified document signer using the file ID.
report	POST /v1/identityVerification/report	Retrieve the ID verification report for the specified document signer.

create_embedded_verification_url

EmbeddedFileLink create_embedded_verification_url(document_id, embedded_file_details=embedded_file_details)

Generate a URL that embeds manual ID verification for the specified document signer into your application.

Example

Api Key Authentication (X-API-KEY):
Api Key Authentication (Bearer):

import boldsign
from boldsign.models.embedded_file_details import EmbeddedFileDetails
from boldsign.models.embedded_file_link import EmbeddedFileLink
from boldsign.rest import ApiException
from pprint import pprint

configuration = boldsign.Configuration(
    api_key = "***your_api_key***"
)

# Enter a context with an instance of the API client
with boldsign.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = boldsign.IdentityVerificationApi(api_client)
    document_id = 'document_id_example' # str | The document id.
    embedded_file_details = boldsign.EmbeddedFileDetails() # EmbeddedFileDetails | The embedded verification link request. (optional)

    try:
        # Generate a URL that embeds manual ID verification for the specified document signer into your application.
        api_response = api_instance.create_embedded_verification_url(document_id, embedded_file_details=embedded_file_details)
        print("The response of IdentityVerificationApi->create_embedded_verification_url:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling IdentityVerificationApi->create_embedded_verification_url: %s\n" % e)

Parameters

Name	Type	Description	Notes
document_id	str	The document id.
embedded_file_details	EmbeddedFileDetails	The embedded verification link request.	[optional]

Return type

EmbeddedFileLink

Authorization

X-API-KEY, Bearer

HTTP request headers

Content-Type: application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=minimal;IEEE754Compatible=false, application/json;odata.metadata=minimal;IEEE754Compatible=true, application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=full;IEEE754Compatible=false, application/json;odata.metadata=full;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=none;IEEE754Compatible=false, application/json;odata.metadata=none;IEEE754Compatible=true, application/json;odata.streaming=true;IEEE754Compatible=false, application/json;odata.streaming=true;IEEE754Compatible=true, application/json;odata.streaming=false;IEEE754Compatible=false, application/json;odata.streaming=false;IEEE754Compatible=true, application/json;IEEE754Compatible=false, application/json;IEEE754Compatible=true, application/xml, text/plain, application/json-patch+json, text/json, application/*+json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

image

io.IOBase image(document_id, download_image_request)

Retrieve the uploaded ID verification document or selfie image for the specified document signer using the file ID.

Example

Api Key Authentication (X-API-KEY):
Api Key Authentication (Bearer):

import boldsign
from boldsign.models.download_image_request import DownloadImageRequest
from boldsign.rest import ApiException
from pprint import pprint

configuration = boldsign.Configuration(
    api_key = "***your_api_key***"
)

# Enter a context with an instance of the API client
with boldsign.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = boldsign.IdentityVerificationApi(api_client)
    document_id = 'document_id_example' # str | The document id.
    download_image_request = boldsign.DownloadImageRequest() # DownloadImageRequest | The download image request.

    try:
        # Retrieve the uploaded ID verification document or selfie image for the specified document signer using the file ID.
        api_response = api_instance.image(document_id, download_image_request)
        print("The response of IdentityVerificationApi->image:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling IdentityVerificationApi->image: %s\n" % e)

Parameters

Name	Type	Description	Notes
document_id	str	The document id.
download_image_request	DownloadImageRequest	The download image request.

Return type

io.IOBase

Authorization

X-API-KEY, Bearer

HTTP request headers

Content-Type: application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=minimal;IEEE754Compatible=false, application/json;odata.metadata=minimal;IEEE754Compatible=true, application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=full;IEEE754Compatible=false, application/json;odata.metadata=full;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=none;IEEE754Compatible=false, application/json;odata.metadata=none;IEEE754Compatible=true, application/json;odata.streaming=true;IEEE754Compatible=false, application/json;odata.streaming=true;IEEE754Compatible=true, application/json;odata.streaming=false;IEEE754Compatible=false, application/json;odata.streaming=false;IEEE754Compatible=true, application/json;IEEE754Compatible=false, application/json;IEEE754Compatible=true, application/xml, text/plain, application/json-patch+json, text/json, application/*+json
Accept: application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=minimal;IEEE754Compatible=false, application/json;odata.metadata=minimal;IEEE754Compatible=true, application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=full;IEEE754Compatible=false, application/json;odata.metadata=full;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=none;IEEE754Compatible=false, application/json;odata.metadata=none;IEEE754Compatible=true, application/json;odata.streaming=true;IEEE754Compatible=false, application/json;odata.streaming=true;IEEE754Compatible=true, application/json;odata.streaming=false;IEEE754Compatible=false, application/json;odata.streaming=false;IEEE754Compatible=true, application/json;IEEE754Compatible=false, application/json;IEEE754Compatible=true, application/xml, text/plain, application/octet-stream, text/json

HTTP response details

Status code	Description	Response headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-
400	Bad Request	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

report

IdReport report(document_id, verification_data_request)

Retrieve the ID verification report for the specified document signer.

Example

Api Key Authentication (X-API-KEY):
Api Key Authentication (Bearer):

import boldsign
from boldsign.models.id_report import IdReport
from boldsign.models.verification_data_request import VerificationDataRequest
from boldsign.rest import ApiException
from pprint import pprint

configuration = boldsign.Configuration(
    api_key = "***your_api_key***"
)

# Enter a context with an instance of the API client
with boldsign.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = boldsign.IdentityVerificationApi(api_client)
    document_id = 'document_id_example' # str | The document id.
    verification_data_request = boldsign.VerificationDataRequest() # VerificationDataRequest | The download image request.

    try:
        # Retrieve the ID verification report for the specified document signer.
        api_response = api_instance.report(document_id, verification_data_request)
        print("The response of IdentityVerificationApi->report:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling IdentityVerificationApi->report: %s\n" % e)

Parameters

Name	Type	Description	Notes
document_id	str	The document id.
verification_data_request	VerificationDataRequest	The download image request.

Return type

IdReport

Authorization

X-API-KEY, Bearer

HTTP request headers

Content-Type: application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=minimal;IEEE754Compatible=false, application/json;odata.metadata=minimal;IEEE754Compatible=true, application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=full;IEEE754Compatible=false, application/json;odata.metadata=full;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false, application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true, application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false, application/json;odata.metadata=none;IEEE754Compatible=false, application/json;odata.metadata=none;IEEE754Compatible=true, application/json;odata.streaming=true;IEEE754Compatible=false, application/json;odata.streaming=true;IEEE754Compatible=true, application/json;odata.streaming=false;IEEE754Compatible=false, application/json;odata.streaming=false;IEEE754Compatible=true, application/json;IEEE754Compatible=false, application/json;IEEE754Compatible=true, application/xml, text/plain, application/json-patch+json, text/json, application/*+json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-
400	Bad Request	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

boldsign.IdentityVerificationApi

create_embedded_verification_url

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

image

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

report

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

FilesExpand file tree

IdentityVerificationApi.md

Latest commit

History

IdentityVerificationApi.md

File metadata and controls

boldsign.IdentityVerificationApi

create_embedded_verification_url

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

image

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

report

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details