Sign in

v1

latestOpenAPI 3.1.02026-07-2685154311.7 KB
Transfer Checks

Complete internal checks

Marks the internal checks as complete for the specified transfer. This endpoint is called after the entity has completed internal operational checks on the provided PII/Travel Rule information.

post/entities/{entityDID}/tx/{transferId}/checks/internal-checks

Path parameters

entityDIDstring did required

Decentralized Identifier (DID)

Example:did:web:vasps.id:jxnl0411:at

The DID of the entity

transferIdstring uuid required
Example:01f09c55-9de0-42c5-874f-237dcb51fd9f

The transfer ID

Response

Internal checks completed

idstring uuid required
transferIdstring uuid required
entityDidstring required
type'REQUIRE_BENEFICIARY_NAME_MATCHING' | 'REQUIRE_INTERNAL_CHECKS' required
status'PENDING' | 'COMPLETE' required

Example response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "transferId": "123e4567-e89b-12d3-a456-426614174000",
  "entityDid": "did:web:example.com",
  "policyData": {
    "confirmedBy": "user@example.com",
    "confirmedAt": "2024-01-01T00:00:00.000Z"
  }
}