trulioo-sdk 1.0.4

Trulioo Python SDK

Trulioo Python SDK

• Package version: 1.0.4
• API version: v1
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Installation & Usage

Python 3.6 or later is required.

With pip

pip install trulioo_sdk

With Setuptools

In the root of this SDK, run:

python setup.py install --user

Sample Application

Check out our sample application for this SDK in the sample-app folder.

Getting Started

Example of testing authentication

from trulioo_sdk import Configuration, ApiException
from trulioo_sdk.apis import ConnectionApi

config = Configuration()

# Configure API key authorization
config.api_key["ApiKeyAuth"] = "YOUR-X-TRULIOO-API-KEY"

# Configure mode: "trial" or "live"
mode = "trial"

# Construct instance of ApiClient with config
api_client = ApiClient(config)

# Construct instance of ConnectionApi with api_client
connectionApi = ConnectionApi(api_client)

# Call ConnectionApi#test_authentication
try:
    result = connectionApi.test_authentication(mode)
    print(result)
except ApiException as e:
    print("Exception when calling ConnectionApi#testAuthentication\n")
    print("Status code:      " + str(e.status))
    print("Reason:           " + str(e.body))
    print("Response headers: " + str(e.headers))

Testing

This project uses tox for consistent testing. Install with pip install tox, then run:

python -m tox

Documentation for APIs

All URIs are relative to https://gateway.trulioo.com.

Class	Method	HTTP request	Description
BusinessApi	get_business_search_result	GET /{mode}/business/v1/search/transactionrecord/{id}	Get Business Search Result
BusinessApi	search	POST /{mode}/business/v1/search	Search
ConfigurationApi	get_business_registration_numbers	GET /{mode}/configuration/v1/businessregistrationnumbers/{countryCode}/{jurisdictionCode}	Get Business Registration Numbers
ConfigurationApi	get_consents	GET /{mode}/configuration/v1/consents/{configurationName}/{countryCode}	Get Consents
ConfigurationApi	get_country_codes	GET /{mode}/configuration/v1/countrycodes/{configurationName}	Get Country Codes
ConfigurationApi	get_country_subdivisions	GET /{mode}/configuration/v1/countrysubdivisions/{countryCode}	Get Country Subdivisions
ConfigurationApi	get_datasources	GET /{mode}/configuration/v1/datasources/{configurationName}/{countryCode}	Get Datasources
ConfigurationApi	get_detailed_consents	GET /{mode}/configuration/v1/detailedConsents/{configurationName}/{countryCode}	Get Detailed Consents
ConfigurationApi	get_document_types	GET /{mode}/configuration/v1/documentTypes/{countryCode}	Get Document Types
ConfigurationApi	get_fields	GET /{mode}/configuration/v1/fields/{configurationName}/{countryCode}	Get Fields
ConfigurationApi	get_recommended_fields	GET /{mode}/configuration/v1/recommendedfields/{configurationName}/{countryCode}	Get Recommended Fields
ConfigurationApi	get_test_entities	GET /{mode}/configuration/v1/testentities/{configurationName}/{countryCode}	Get Test Entities
ConnectionApi	connection_async_callback_url	POST /{mode}/connection/v1/async-callback	Connection Async Callback Url
ConnectionApi	say_hello	GET /{mode}/connection/v1/sayhello/{name}	Say Hello
ConnectionApi	test_authentication	GET /{mode}/connection/v1/testauthentication	Test Authentication
VerificationsApi	document_download	GET /{mode}/verifications/v1/documentdownload/{transactionRecordId}/{fieldName}	Document Download
VerificationsApi	get_transaction_record	GET /{mode}/verifications/v1/transactionrecord/{id}	Get Transaction Record
VerificationsApi	get_transaction_record_address	GET /{mode}/verifications/v1/transactionrecord/{id}/withaddress	Get Transaction Record Address
VerificationsApi	get_transaction_record_document	GET /{mode}/verifications/v1/transactionrecord/{transactionRecordID}/{documentField}	Get Transaction Record Document
VerificationsApi	get_transaction_record_verbose	GET /{mode}/verifications/v1/transactionrecord/{id}/verbose	Get Transaction Record Verbose
VerificationsApi	get_transaction_status	GET /{mode}/verifications/v1/transaction/{id}/status	Get Transaction Status
VerificationsApi	verify	POST /{mode}/verifications/v1/verify	Verify

Documentation For Models

• Address
• AppendedField
• Business
• BusinessRecord
• BusinessRegistrationNumber
• BusinessRegistrationNumberMask
• BusinessResult
• BusinessSearchRequest
• BusinessSearchRequestBusinessSearchModel
• BusinessSearchResponse
• BusinessSearchResponseIndustryCode
• Communication
• Consent
• CountrySubdivision
• DataField
• DataFields
• DatasourceField
• DatasourceResult
• Document
• DriverLicence
• Location
• LocationAdditionalFields
• NationalId
• NormalizedDatasourceField
• NormalizedDatasourceGroupCountry
• Passport
• PersonInfo
• PersonInfoAdditionalFields
• Record
• RecordRule
• Result
• ServiceError
• TestEntityDataFields
• TransactionRecordResult
• TransactionRecordResultAllOf
• TransactionStatus
• VerifyRequest
• VerifyResult

Documentation For Authorization

ApiKeyAuth

• Type: API key
• API key parameter name: x-trulioo-api-key
• Location: HTTP header