Glossary

One of the two verdict tiers of the personal background report — whether the supplier may use the platform. Contrast advance tier. See download_personal_background_report.

The second verdict tier of the personal background report — whether the supplier may receive advances.

An Onfido object representing the person being verified. Created from the owner’s first and last name before a workflow run can start.

The vendor performing identity-document verification (BOS4 API). Being replaced by Entrust. See Au10tix.

A shared Payability HTTP service that performs StartWorkflowExecution on SWF. The Web API calls it instead of calling SWF directly.

The append-only DynamoDB table auditing every final-status and tool mutation, stamped with the application version. See data/dynamodb.adoc#changelog-table.

Thomson Reuters CLEAR, the vendor behind KYC (EIDV) and the background reports.

An identifier of a compliance category in Payability’s document store. Identity documents captured through Entrust are uploaded under the KYC identity compliance key.

The single id tying one process execution together — the task row’s task_id, the final-status partition key, the SWF task_correlation_id, and the log prefix. For Entrust it is the workflow_run_id.

The S3 bucket holding raw vendor responses (payability-datalake). See S3 datalake.

The configuration library that assembles settings from the generated settings.json and .secrets.json. See Configuration & secrets.

Electronic Identity Verification — the CLEAR product used for the KYC check.

Onfido’s hosted identity-verification product, the eventual replacement for Au10tix. Its API is the Onfido REST API. See Entrust / Onfido.

The underwriting verdict for one execution, stored per correlation_id with full version history and overridable by an underwriter. See data/dynamodb.adoc#final-status-table.

The numeric caller identifier the B2B Task Manager requires (B2B_TASK_MANAGER_GCI); 1 in production, derived from the environment name in dev.

The second, asynchronous step of a process, run by the SWF worker. Also called a handle-response task.

The Onfido URL a supplier opens to complete verification, with an expiry; reused by POST /entrust/sessions while it is still valid.

The first, synchronous step of a process, run inside the Web API. Also called the request task.

The video or motion capture Onfido records to prove the person is present. Uploaded to the document store in a second request, after the identity documents.

Onfido’s alternative liveness modality to a live video; a run produces one or the other.

The supplier owner’s login key. Combined with supplier_key it identifies the subject of a process.

A named underwriting workflow with two ordered steps. Four exist. See Process catalog.

Where a request came from — internal, supplier_dashboard or onboarding. Drives authorization and rate limits. See Auth & permissions.

Deleting the archived S3 results of a process and marking the task rows purged, via DELETE /tasks/result. Implemented by the Thomson Reuters handle tasks only.

Payability’s internal Python SDK — provides PybApiAuth (session-token auth) and the CloudWatch metric helpers. Pinned to a Python 3.9-compatible branch, which is why this service cannot move to a newer Python.

One block of a CLEAR personal background report (ArrestSection, CriminalSection, …), scored PASS / FAIL / ERROR.

The Payability supplier identifier — the partition key of the tool and changelog tables, and the HubSpot contact’s supplierkey.

AWS Simple Workflow, which runs the asynchronous handle step as an activity. See SWF orchestration.

One executable unit with a unique task_name. See Domain model: processes & tasks.

The SWF queue this repository’s worker polls: automatic-uw-tool-task-list.

A verification capability tracked per supplier and person, with a status — what GET /tools renders as the underwriting checklist. See Tool endpoints.

An Onfido execution of a Studio workflow for one applicant. Its id is the Entrust correlation_id and the TaskExecutionTable task_id.