Skip to content
API Reference
/
Truuth
/
CreateVerificationSession

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server

https://docs.bndry.net/_mock/apis/openapi/

https://api.bndry.app/

Documents

Service for managing documents.

Operations

Form Definitions

Service for managing form definitions.

Operations

Forms

Operations

Workspaces

Service for managing workspaces and their associated forms and documents.

Operations

Automations

Service for managing and executing automations.

Operations

Truuth

TruuthService provides an API for the BNDRY SPA to initiate a new verification session with Truuth

Operations

CreateVerificationSession

Request

CreateSession initiates a new verification session with identity owner details

Security
oauth2_client_credentials or oauth2_authorization_code
Headers
Connect-Protocol-Versionnumber(Connect-Protocol-Version)required

Define the version of the Connect protocol

Value1
Value 1
Connect-Timeout-Msnumber(Connect-Timeout-Ms)

Define the timeout, in ms

Bodyapplication/jsonrequired
identityOwneridentity_owner (object) or identity_owner (object)(bndry.api.risk.truuth.v1alpha.IdentityOwner)required
One of:

Details of the person being verified.

identityOwner.​emailstring(email)(email)required

Customer's email address.

curl -i -X POST \
  https://docs.bndry.net/_mock/apis/openapi/bndry.api.risk.truuth.v1alpha.TruuthService/CreateVerificationSession \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Connect-Protocol-Version: 1' \
  -H 'Connect-Timeout-Ms: 0' \
  -H 'Content-Type: application/json' \
  -d '{
    "identityOwner": {
      "email": "john.smith@example.com"
    }
  }'

Responses

Success

Bodyapplication/json
tokenstring(token)non-empty

The access token required for calling SDK endpoints.

tenantstring(tenant)^[a-z0-9-]+$

Tenant alias with all letters in lower case.

apiUrlstring(uri)(api_url)

The base URL used for the verification submission process.

identityOwneridentity_owner (object) or identity_owner (object)(bndry.api.risk.truuth.v1alpha.IdentityOwner)required
One of:

Details of the person being verified.

identityOwner.​emailstring(email)(email)required

Customer's email address.

Response
application/json
{
  "token": "tk_live_abc123xyz789",
  "tenant": "example-financial",
  "apiUrl": "https://api.truuth.com/v1",
  "identityOwner": {
    "email": "john.smith@example.com"
  }
}

ReceiveCallback

Request

ReceiveCallback handles verification completion webhooks from Truuth

Security
oauth2_client_credentials or oauth2_authorization_code
Bodyapplication/jsonrequired
verificationIdstring(verification_id)

Unique verification identifier

externalRefIdstring(external_ref_id)

Reference identifier for easy identification

statusstring(bndry.api.risk.truuth.v1alpha.VerificationStatus)

Verification status

Enum"VERIFICATION_STATUS_UNSPECIFIED""VERIFICATION_STATUS_DONE""VERIFICATION_STATUS_IN_PROGRESS""VERIFICATION_STATUS_PROCESSING""VERIFICATION_STATUS_ERROR"
identityOwnerobject(bndry.api.risk.truuth.v1alpha.WebhookIdentityOwner)

Identity owner details from verification

resultsobject(bndry.api.risk.truuth.v1alpha.VerificationResults)

Verification results containing proofing outcomes

createdAtstring(date-time)(google.protobuf.Timestamp)

Verification created date-time

curl -i -X POST \
  https://docs.bndry.net/_mock/apis/openapi/v1alpha/truuth/webhooks/callback \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "verificationId": "string",
    "externalRefId": "string",
    "status": "VERIFICATION_STATUS_UNSPECIFIED",
    "identityOwner": {
      "givenName": "string",
      "familyName": "string",
      "middleName": "string",
      "dateOfBirth": "string",
      "email": "string",
      "gender": "string",
      "mobileNumber": "string"
    },
    "results": {
      "proofingOutcomes": [
        {
          "status": "string",
          "proofingType": {
            "code": "string",
            "name": "string"
          },
          "documents": [
            {
              "metadata": {
                "property1": "string",
                "property2": "string"
              }
            }
          ],
          "userBehaviourChecks": [
            {
              "type": "string",
              "name": "string",
              "status": "string",
              "score": 0.1
            }
          ]
        }
      ],
      "otherCheckOutcomes": [
        {
          "type": "string",
          "name": "string",
          "status": "string"
        }
      ],
      "faceImage": "string",
      "reports": [
        {
          "type": "string",
          "url": "string",
          "metadata": {
            "property1": "string",
            "property2": "string"
          }
        }
      ]
    },
    "createdAt": "1s"
  }'

Responses

Success

Bodyapplication/json
successboolean(success)

Success status

messagestring(message)

Optional message

Response
application/json
{
  "success": true,
  "message": "string"
}

EventService

EventService provides operations for managing events

Operations

Notes

Operations

Tenants

Service for managing tenants.

Operations

Entities

Operations

Onboard Individual (Verify Identity)

Service for managing individual entity onboarding jobs.

Operations