Skip to content

README.md

Latest commit

 

History

History
390 lines (259 loc) · 21.8 KB

README.md

File metadata and controls

390 lines (259 loc) · 21.8 KB
Raw

Verification

Overview

Available Operations

create_verification_request

Create a request

Example Usage

from unified_python_sdk import UnifiedTo
from unified_python_sdk.models import shared


with UnifiedTo(
    security=shared.Security(
        jwt="<YOUR_API_KEY_HERE>",
    ),
) as unified_to:

    res = unified_to.verification.create_verification_request(request={
        "verification_request": {},
        "connection_id": "<id>",
    })

    assert res.verification_request is not None

    # Handle response
    print(res.verification_request)

Parameters

Parameter Type Required Description
request operations.CreateVerificationRequestRequest ✔️ The request object to use for the request.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.CreateVerificationRequestResponse

Errors

Error Type Status Code Content Type
errors.SDKError 4XX, 5XX */*

get_verification_package

Retrieve a package

Example Usage

from unified_python_sdk import UnifiedTo
from unified_python_sdk.models import shared


with UnifiedTo(
    security=shared.Security(
        jwt="<YOUR_API_KEY_HERE>",
    ),
) as unified_to:

    res = unified_to.verification.get_verification_package(request={
        "connection_id": "<id>",
        "id": "<id>",
    })

    assert res.verification_package is not None

    # Handle response
    print(res.verification_package)

Parameters

Parameter Type Required Description
request operations.GetVerificationPackageRequest ✔️ The request object to use for the request.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.GetVerificationPackageResponse

Errors

Error Type Status Code Content Type
errors.SDKError 4XX, 5XX */*

get_verification_request

Retrieve a request

Example Usage

from unified_python_sdk import UnifiedTo
from unified_python_sdk.models import shared


with UnifiedTo(
    security=shared.Security(
        jwt="<YOUR_API_KEY_HERE>",
    ),
) as unified_to:

    res = unified_to.verification.get_verification_request(request={
        "connection_id": "<id>",
        "id": "<id>",
    })

    assert res.verification_request is not None

    # Handle response
    print(res.verification_request)

Parameters

Parameter Type Required Description
request operations.GetVerificationRequestRequest ✔️ The request object to use for the request.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.GetVerificationRequestResponse

Errors

Error Type Status Code Content Type
errors.SDKError 4XX, 5XX */*

list_verification_packages

List all packages

Example Usage

from unified_python_sdk import UnifiedTo
from unified_python_sdk.models import shared


with UnifiedTo(
    security=shared.Security(
        jwt="<YOUR_API_KEY_HERE>",
    ),
) as unified_to:

    res = unified_to.verification.list_verification_packages(request={
        "connection_id": "<id>",
    })

    assert res.verification_packages is not None

    # Handle response
    print(res.verification_packages)

Parameters

Parameter Type Required Description
request operations.ListVerificationPackagesRequest ✔️ The request object to use for the request.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.ListVerificationPackagesResponse

Errors

Error Type Status Code Content Type
errors.SDKError 4XX, 5XX */*

list_verification_requests

List all requests

Example Usage

from unified_python_sdk import UnifiedTo
from unified_python_sdk.models import shared


with UnifiedTo(
    security=shared.Security(
        jwt="<YOUR_API_KEY_HERE>",
    ),
) as unified_to:

    res = unified_to.verification.list_verification_requests(request={
        "connection_id": "<id>",
    })

    assert res.verification_requests is not None

    # Handle response
    print(res.verification_requests)

Parameters

Parameter Type Required Description
request operations.ListVerificationRequestsRequest ✔️ The request object to use for the request.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.ListVerificationRequestsResponse

Errors

Error Type Status Code Content Type
errors.SDKError 4XX, 5XX */*

patch_verification_request

Update a request

Example Usage

from unified_python_sdk import UnifiedTo
from unified_python_sdk.models import shared


with UnifiedTo(
    security=shared.Security(
        jwt="<YOUR_API_KEY_HERE>",
    ),
) as unified_to:

    res = unified_to.verification.patch_verification_request(request={
        "verification_request": {},
        "connection_id": "<id>",
        "id": "<id>",
    })

    assert res.verification_request is not None

    # Handle response
    print(res.verification_request)

Parameters

Parameter Type Required Description
request operations.PatchVerificationRequestRequest ✔️ The request object to use for the request.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.PatchVerificationRequestResponse

Errors

Error Type Status Code Content Type
errors.SDKError 4XX, 5XX */*

remove_verification_request

Remove a request

Example Usage

from unified_python_sdk import UnifiedTo
from unified_python_sdk.models import shared


with UnifiedTo(
    security=shared.Security(
        jwt="<YOUR_API_KEY_HERE>",
    ),
) as unified_to:

    res = unified_to.verification.remove_verification_request(request={
        "connection_id": "<id>",
        "id": "<id>",
    })

    assert res is not None

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
request operations.RemoveVerificationRequestRequest ✔️ The request object to use for the request.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.RemoveVerificationRequestResponse

Errors

Error Type Status Code Content Type
errors.SDKError 4XX, 5XX */*

update_verification_request

Update a request

Example Usage

from unified_python_sdk import UnifiedTo
from unified_python_sdk.models import shared


with UnifiedTo(
    security=shared.Security(
        jwt="<YOUR_API_KEY_HERE>",
    ),
) as unified_to:

    res = unified_to.verification.update_verification_request(request={
        "verification_request": {},
        "connection_id": "<id>",
        "id": "<id>",
    })

    assert res.verification_request is not None

    # Handle response
    print(res.verification_request)

Parameters

Parameter Type Required Description
request operations.UpdateVerificationRequestRequest ✔️ The request object to use for the request.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.UpdateVerificationRequestResponse

Errors

Error Type Status Code Content Type
errors.SDKError 4XX, 5XX */*