Skip to content

Latest commit

 

History

History
379 lines (290 loc) · 24.3 KB

VerifyService.md

File metadata and controls

379 lines (290 loc) · 24.3 KB

VerifyService

A list of all methods in the VerifyService service. Click on the method name to view detailed information about that method.

Methods Description
verify_identity Verification of the identity of a personal contact associated with a wallet.
get_kyc_id_verification_supported_doc_types Use this method to determine the types of documents to use for identification purposes, and also whether you need the reverse side of the document. You can filter your search results by country with the country query parameter.
get_application_types_by_country Retrieve a List types of identity verification applications by country. You can filter the list with query parameters.
get_application_status Retrieve the status of an application for verification of identity. You can filter the list with query parameters.
create_hosted_application_token Create an application for Rapyd Verify where the client (applicant) provides information directly to Rapyd. After the applicant submits the application on the hosted page, Rapyd verifies the information. When the status of the application changes, Rapyd sends you a webhook.
get_hosted_application_by_token Retrieve Rapyd Verify Application
identity_verification_page Create a hosted page for verifying the identity of a personal contact for a Rapyd Wallet.<BR>The customer completes the process by accessing the URL returned in the response.<BR>After the customer submits the identity verification request on the hosted page, Rapyd verifies the information and sends you a webhook with a summary of the identity check. See:<BR>_ Identity Verification Webhook - Sandbox Approved<BR>_ Identity Verification Webhook - Production Approved<BR>_ Identity Verification Webhook - Production Not Approved<BR>Prerequisites<BR>_ Rapyd Wallet

verify_identity

Verification of the identity of a personal contact associated with a wallet.

  • HTTP Method: POST
  • Endpoint: /v1/identities

Parameters

Name Type Required Description
request_body V1IdentitiesBody ✅ The request body.
access_key str ✅ Unique access key provided by Rapyd for each authorized user.
content_type str ✅ Indicates that the data appears in JSON format. Set to application/json.
salt str ✅ Random string. Recommended length: 8-16 characters.
signature str ✅ Signature calculated for each request individually. See Request Signatures.
timestamp str ✅ Timestamp for the request, in Unix time (seconds).
idempotency str ❌ A unique key that prevents the platform from creating the same object twice.

Return Type

InlineResponse200_111

Example Usage Code Snippet

from rapyd_sdk import RapydSdk, Environment
from rapyd_sdk.models import V1IdentitiesBody

sdk = RapydSdk(
    base_url=Environment.DEFAULT.value,
    timeout=10000
)

request_body = V1IdentitiesBody(
    back_side_image="back_side_image",
    back_side_image_mime_type="back_side_image_mime_type",
    contact="contact",
    country="GB",
    document_type="document_type",
    ewallet="ewallet",
    face_image="face_image",
    face_image_mime_type="face_image_mime_type",
    front_side_image="front_side_image",
    front_side_image_mime_type="front_side_image_mime_type",
    reference_id="reference_id",
    request_type="request_type",
    send_callback="send_callback"
)

result = sdk.verify.verify_identity(
    request_body=request_body,
    access_key="access_key",
    content_type="Content-Type",
    salt="salt",
    signature="signature",
    timestamp="timestamp",
    idempotency="idempotency"
)

print(result)

get_kyc_id_verification_supported_doc_types

Use this method to determine the types of documents to use for identification purposes, and also whether you need the reverse side of the document. You can filter your search results by country with the country query parameter.

  • HTTP Method: GET
  • Endpoint: /v1/identities/types

Parameters

Name Type Required Description
country str ✅ Two-letter ISO 3166-1 ALPHA-2 code for the country. Uppercase.
access_key str ✅ Unique access key provided by Rapyd for each authorized user.
content_type str ✅ Indicates that the data appears in JSON format. Set to application/json.
salt str ✅ Random string. Recommended length: 8-16 characters.
signature str ✅ Signature calculated for each request individually. See Request Signatures.
timestamp str ✅ Timestamp for the request, in Unix time (seconds).
idempotency str ❌ A unique key that prevents the platform from creating the same object twice.

Return Type

InlineResponse200_112

Example Usage Code Snippet

from rapyd_sdk import RapydSdk, Environment

sdk = RapydSdk(
    base_url=Environment.DEFAULT.value,
    timeout=10000
)

result = sdk.verify.get_kyc_id_verification_supported_doc_types(
    country="GB",
    access_key="access_key",
    content_type="Content-Type",
    salt="salt",
    signature="signature",
    timestamp="timestamp",
    idempotency="idempotency"
)

print(result)

get_application_types_by_country

Retrieve a List types of identity verification applications by country. You can filter the list with query parameters.

  • HTTP Method: GET
  • Endpoint: /v1/verify/applications/types/country/{country}

Parameters

Name Type Required Description
country str ✅ Two-letter ISO 3166-1 ALPHA-2 code for the country. Uppercase.
access_key str ✅ Unique access key provided by Rapyd for each authorized user.
content_type str ✅ Indicates that the data appears in JSON format. Set to application/json.
salt str ✅ Random string. Recommended length: 8-16 characters.
signature str ✅ Signature calculated for each request individually. See Request Signatures.
timestamp str ✅ Timestamp for the request, in Unix time (seconds).
idempotency str ❌ A unique key that prevents the platform from creating the same object twice.

Return Type

InlineResponse200_113

Example Usage Code Snippet

from rapyd_sdk import RapydSdk, Environment

sdk = RapydSdk(
    base_url=Environment.DEFAULT.value,
    timeout=10000
)

result = sdk.verify.get_application_types_by_country(
    country="GB",
    access_key="access_key",
    content_type="Content-Type",
    salt="salt",
    signature="signature",
    timestamp="timestamp",
    idempotency="idempotency"
)

print(result)

get_application_status

Retrieve the status of an application for verification of identity. You can filter the list with query parameters.

  • HTTP Method: GET
  • Endpoint: /v1/verify/applications/status/{application}

Parameters

Name Type Required Description
application str ✅ ID of the application. String starting with app_.
access_key str ✅ Unique access key provided by Rapyd for each authorized user.
content_type str ✅ Indicates that the data appears in JSON format. Set to application/json.
salt str ✅ Random string. Recommended length: 8-16 characters.
signature str ✅ Signature calculated for each request individually. See Request Signatures.
timestamp str ✅ Timestamp for the request, in Unix time (seconds).
idempotency str ❌ A unique key that prevents the platform from creating the same object twice.

Return Type

InlineResponse200_114

Example Usage Code Snippet

from rapyd_sdk import RapydSdk, Environment

sdk = RapydSdk(
    base_url=Environment.DEFAULT.value,
    timeout=10000
)

result = sdk.verify.get_application_status(
    application="application",
    access_key="access_key",
    content_type="Content-Type",
    salt="salt",
    signature="signature",
    timestamp="timestamp",
    idempotency="idempotency"
)

print(result)

create_hosted_application_token

Create an application for Rapyd Verify where the client (applicant) provides information directly to Rapyd. After the applicant submits the application on the hosted page, Rapyd verifies the information. When the status of the application changes, Rapyd sends you a webhook.

  • HTTP Method: POST
  • Endpoint: /v1/verify/applications/hosted

Parameters

Name Type Required Description
request_body ApplicationsHostedBody ❌ The request body.
access_key str ✅ Unique access key provided by Rapyd for each authorized user.
content_type str ✅ Indicates that the data appears in JSON format. Set to application/json.
salt str ✅ Random string. Recommended length: 8-16 characters.
signature str ✅ Signature calculated for each request individually. See Request Signatures.
timestamp str ✅ Timestamp for the request, in Unix time (seconds).
idempotency str ❌ A unique key that prevents the platform from creating the same object twice.

Return Type

InlineResponse200_115

Example Usage Code Snippet

from rapyd_sdk import RapydSdk, Environment
from rapyd_sdk.models import ApplicationsHostedBody

sdk = RapydSdk(
    base_url=Environment.DEFAULT.value,
    timeout=10000
)

request_body = ApplicationsHostedBody(
    application_type="application_type",
    country="country",
    rapyd_entity_token="ewallet_ef84c580177dbfc4293b1cf73c73fc77",
    phone_number="phone_number",
    metadata={},
    client_reference_id="client_reference_id",
    cancel_url="cancel_url",
    complete_url="complete_url"
)

result = sdk.verify.create_hosted_application_token(
    request_body=request_body,
    access_key="access_key",
    content_type="Content-Type",
    salt="salt",
    signature="signature",
    timestamp="timestamp",
    idempotency="idempotency"
)

print(result)

get_hosted_application_by_token

Retrieve Rapyd Verify Application

  • HTTP Method: GET
  • Endpoint: /v1/verify/applications/hosted/{verifyAppId}

Parameters

Name Type Required Description
verify_app_id str ✅ ID of the Rapyd Verify application. String starting with happ_.
access_key str ✅ Unique access key provided by Rapyd for each authorized user.
content_type str ✅ Indicates that the data appears in JSON format. Set to application/json.
salt str ✅ Random string. Recommended length: 8-16 characters.
signature str ✅ Signature calculated for each request individually. See Request Signatures.
timestamp str ✅ Timestamp for the request, in Unix time (seconds).
idempotency str ❌ A unique key that prevents the platform from creating the same object twice.

Return Type

InlineResponse200_116

Example Usage Code Snippet

from rapyd_sdk import RapydSdk, Environment

sdk = RapydSdk(
    base_url=Environment.DEFAULT.value,
    timeout=10000
)

result = sdk.verify.get_hosted_application_by_token(
    verify_app_id="verifyAppId",
    access_key="access_key",
    content_type="Content-Type",
    salt="salt",
    signature="signature",
    timestamp="timestamp",
    idempotency="idempotency"
)

print(result)

identity_verification_page

Create a hosted page for verifying the identity of a personal contact for a Rapyd Wallet.<BR>The customer completes the process by accessing the URL returned in the response.<BR>After the customer submits the identity verification request on the hosted page, Rapyd verifies the information and sends you a webhook with a summary of the identity check. See:<BR>_ Identity Verification Webhook - Sandbox Approved<BR>_ Identity Verification Webhook - Production Approved<BR>_ Identity Verification Webhook - Production Not Approved<BR>Prerequisites<BR>_ Rapyd Wallet

  • HTTP Method: POST
  • Endpoint: /v1/hosted/idv

Parameters

Name Type Required Description
request_body HostedIdvBody ✅ The request body.
access_key str ✅ Unique access key provided by Rapyd for each authorized user.
content_type str ✅ Indicates that the data appears in JSON format. Set to application/json.
salt str ✅ Random string. Recommended length: 8-16 characters.
signature str ✅ Signature calculated for each request individually. See Request Signatures.
timestamp str ✅ Timestamp for the request, in Unix time (seconds).
idempotency str ❌ A unique key that prevents the platform from creating the same object twice.

Return Type

InlineResponse200_117

Example Usage Code Snippet

from rapyd_sdk import RapydSdk, Environment
from rapyd_sdk.models import HostedIdvBody

sdk = RapydSdk(
    base_url=Environment.DEFAULT.value,
    timeout=10000
)

request_body = HostedIdvBody(
    cancel_url="cancel_url",
    complete_url="complete_url",
    contact="contact",
    country="country",
    document_type="document_type",
    ewallet="ewallet",
    force_camera=True,
    language="language",
    page_expiration=8.05,
    reference_id="reference_id",
    request_type="store"
)

result = sdk.verify.identity_verification_page(
    request_body=request_body,
    access_key="access_key",
    content_type="Content-Type",
    salt="salt",
    signature="signature",
    timestamp="timestamp",
    idempotency="idempotency"
)

print(result)