ROOKDocs
Sign In
POST

Simulate an enrollment review

ENDPOINT/v1/simulate/wallet-entities/{wallet_entity_id}/enrollment-review

Completes identity verification for a sandbox wallet entity without waiting on the KYC vendor. ACCEPTED sets verification.status VERIFIED and wallet entity status ACTIVE. REJECTED sets verification.status REJECTED and copies reasons onto verification.failure_reasons. Platform events: wallet_entity.verification.updated. Wallet entities that are already VERIFIED or REJECTED reject this transition. Served only on the sandbox host.

Authentication & Headers

HeaderTypeRequirementDescription
AuthorizationstringREQUIREDAPI key passed as an HTTP Bearer token: Bearer rk_live_...
X-Program-IDUUIDPROGRAM-SCOPEDProgram boundary UUID that scopes the issuing card, wallet, or transfer.
Content-TypestringREQUIREDMust be application/json.
Idempotency-KeystringOPTIONALUnique UUID to prevent duplicate execution of financial creations or mutations.

Path Parameters

ParameterTypeRequirementDescription
wallet_entity_idstringREQUIREDUnique identifier of the wallet entity.

Request Body Schema

application/json
statusstring
REQUIRED

Outcome to apply to the wallet entity's identity check. `ACCEPTED` sets `verification.status` to `VERIFIED`. `REJECTED` sets it to `REJECTED` and copies `reasons` onto `verification.failure_reasons`.

Enum values:ACCEPTEDREJECTED
reasonsarray
REQUIRED

Copied onto `verification.failure_reasons` when `status` is `REJECTED`. Empty when `status` is `ACCEPTED`.

Response Codes & Schemas

200The Wallet Entity after the enrollment decision.
application/json
{
  "id": "2e9c4b71-8a5d-4f03-b6e2-1c7d9a0f3e58",
  "object": "wallet_entity",
  "type": "PERSON",
  "status": "ACTIVE",
  "first_name": "Jane",
  "last_name": "Doe",
  "date_of_birth": "1990-04-12",
  "ssn_last4": "1234",
  "email": "jane.doe@example.com",
  "phone": "+15125550100",
  "address": {
    "line_1": "100 Main St",
    "line_2": null,
    "city": "Austin",
    "state": "TX",
    "postal_code": "78701",
    "country": "US"
  },
  "verification": {
    "status": "VERIFIED",
    "submitted_at": "2026-08-12T10:16:00Z",
    "completed_at": "2026-08-12T10:22:00Z",
    "failure_reasons": []
  },
  "external_id": "holder_jane_doe_001",
  "program_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "created_at": "2026-08-12T10:15:00Z",
  "updated_at": "2026-08-12T10:22:00Z"
}
400Bad Request: malformed JSON, failed schema validation, or conflicting parameters.
application/json
{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_request",
    "message": "invalid order by: foo. Valid options are: [created_at updated_at]",
    "param": "order_by",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/invalid_request"
  }
}
401Unauthorized: missing, malformed, or unknown API key.
application/json
{
  "error": {
    "type": "authentication_error",
    "code": "authentication_error",
    "message": "A valid API key is required.",
    "param": null,
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/authentication_error"
  }
}
403Forbidden: the API key is denied by RBAC, or it cannot access this program. A resource that exists on another program or organization returns `404 not_found`, not `403`.
application/json
{
  "error": {
    "type": "permission_error",
    "code": "permission_denied",
    "message": "The API key cannot access this program.",
    "param": "X-Program-ID",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/permission_denied"
  }
}
404Not Found: unknown id, or the resource is not visible to this API key.
application/json
{
  "error": {
    "type": "not_found_error",
    "code": "not_found",
    "message": "No card found for the given id.",
    "param": "card_id",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/not_found"
  }
}
409Conflict: incompatible state, or Idempotency-Key reused with a different body.
application/json
{
  "error": {
    "type": "conflict_error",
    "code": "conflict",
    "message": "The card cannot be reissued from its current state.",
    "param": null,
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/conflict"
  }
}
422Unprocessable Entity: the document is valid JSON but violates a business rule.
application/json
{
  "error": {
    "type": "invalid_request_error",
    "code": "insufficient_funds",
    "message": "The source financial account does not have enough available balance.",
    "param": "amount",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/insufficient_funds"
  }
}
429Too Many Requests: the API key exceeded its rate limit.
application/json
{
  "error": {
    "type": "rate_limit_error",
    "code": "rate_limited",
    "message": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
    "param": null,
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/rate_limited"
  }
}
500Internal Server Error: unexpected failure. Retry with the same Idempotency-Key.
application/json
{
  "error": {
    "type": "api_error",
    "code": "internal_error",
    "message": "An unexpected error occurred. Retry with the same Idempotency-Key.",
    "param": null,
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/internal_error"
  }
}