vouchsafe-python 0.1.1

Vouchsafe API docs

Vouchsafe-python

Vouchsafe offers a REST API to conduct operations programmatically.

You can request and manage verifications, as well as perform smart lookups.

To use the API, you need a client ID and secret from the Vouchsafe dashboard. Sign up here if you haven't already.

We also have a video guide showing the basics, as well as SDKs and libraries for popular languages.

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 0.1.0
• Package version: 0.1.0
• Generator version: 7.16.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://help.vouchsafe.id

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import vouchsafe_python

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import vouchsafe_python

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import vouchsafe_python
from vouchsafe_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://app.vouchsafe.id/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = vouchsafe_python.Configuration(
    host = "https://app.vouchsafe.id/api/v1"
)



# Enter a context with an instance of the API client
with vouchsafe_python.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = vouchsafe_python.AuthenticationApi(api_client)
    authenticate_input = vouchsafe_python.AuthenticateInput() # AuthenticateInput |

    try:
        api_response = api_instance.authenticate(authenticate_input)
        print("The response of AuthenticationApi->authenticate:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AuthenticationApi->authenticate: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://app.vouchsafe.id/api/v1

Class	Method	HTTP request	Description
AuthenticationApi	authenticate	POST /authenticate
FlowsApi	get_flow	GET /flows/{id}
FlowsApi	list_flows	GET /flows
SmartLookupsApi	perform_smart_lookup	POST /smart-lookups
SmartLookupsApi	search_postcode	GET /smart-lookups/postcode
TeamApi	create_team	POST /team
TeamApi	get_team	GET /team
VerificationsApi	get_verification	GET /verifications/{id}
VerificationsApi	list_verifications	GET /verifications
VerificationsApi	request_verification	POST /verifications

Documentation For Models

• ApiErrorResponse
• AuthenticateInput
• AuthenticateResponse
• CheckResult
• CheckState
• CreateTeamInput
• CreateTeamResponse
• CreateTeamResponseCredentials
• Flow
• FlowTemplate
• GetSmartLookupResponse
• Model36EnumsBackgroundCheck
• Model36EnumsEnvironment
• PostcodeResponse
• Reason
• RecordAddressVerificationChecksCheckResult
• Report
• RequestVerificationInput
• RequestVerificationResponse
• SmartLookupInput
• Status
• Team
• Verification

Documentation For Authorization

Authentication schemes defined for the API:

bearerAuth

• Type: Bearer authentication (JWT)

Author

[e-mail]