ROOKDocs
Sign In
PATCH

Update a wallet entity

ENDPOINT/v1/wallet-entities/{wallet_entity_id}

Applies a partial PII update. Omitted fields are left unchanged. Set resubmit_for_verification to true after material identity changes so a new check runs. Closed wallet entities reject updates.

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
first_namestring
optional

Given name. Valid on `PERSON` wallet entities.

last_namestring
optional

Family name. Valid on `PERSON` wallet entities.

date_of_birthstringdate
optional

Date of birth, `YYYY-MM-DD`. Valid on `PERSON` wallet entities.

ssn_last4string
optional

Last four digits of the US Social Security Number.

government_idobject
optional

Government-issued identification. Send `number` on create and update. Reads return `last4` and never the full number.

Properties of government_id
typestringrequired
Kind of identification document.
countrystringrequired
ISO 3166-1 alpha-2 country that issued the document.
numberstring
Full identification number. Write-only; never returned on reads.
last4string
Last four characters of the identification number.
legal_namestring
optional

Registered legal name. Valid on `BUSINESS` wallet entities.

legal_typestring
optional

Legal form of a business wallet entity, used for KYB.

Enum values:SOLE_PROPRIETORSHIPGENERAL_PARTNERSHIPLIMITED_PARTNERSHIPLLCCORPORATIONPROFESSIONAL_ASSOCIATIONTRUSTGOVERNMENTNON_PROFITOTHER
dbastringnull
optional

Doing-business-as name. Send null to clear. Valid on `BUSINESS` wallet entities.

tax_idstring
optional

US Employer Identification Number. Write-only. Valid on `BUSINESS` wallet entities.

control_personobject
optional

Individual with significant managerial control of a business wallet entity. Send `ssn_last4` and/or `government_id` on write. Reads return `ssn_last4` and `government_id.last4`, never a full government number.

Properties of control_person
first_namestringrequired
Given name.
last_namestringrequired
Family name.
date_of_birthstringrequired
Date of birth, `YYYY-MM-DD`.
ssn_last4stringnull
Last four digits of the US Social Security Number. Null when a `government_id` was supplied instead.
government_idobject
Government-issued identification. Send `number` on create and update. Reads return `last4` and never the full number.
emailstringrequired
Email address.
phonestringrequired
Phone number in E.164.
addressobjectrequired
Postal address. `country` is an ISO 3166-1 alpha-2 code. For US addresses, `state` is the two-letter subdivision and `postal_code` is the ZIP or ZIP+4.
titlestringrequired
Role at the business, such as CEO or Managing Member.
emailstringemail
optional

Primary email address.

phonestring
optional

Primary phone number in E.164.

addressobject
optional

Postal address. `country` is an ISO 3166-1 alpha-2 code. For US addresses, `state` is the two-letter subdivision and `postal_code` is the ZIP or ZIP+4.

Properties of address
line_1stringrequired
Street number and name.
line_2stringnull
Apartment, suite, or unit. Null when unused.
citystringrequired
City or locality.
statestringrequired
State, province, or subdivision.
postal_codestringrequired
Postal code.
countrystringrequired
ISO 3166-1 alpha-2 country code.
external_idstringnull
optional

Integrator-assigned identifier. Send null to clear.

resubmit_for_verificationboolean
optional

When true, the updated identity data is submitted for a new verification check. Omit or send false to store the change without starting a check.

Response Codes & Schemas

200The wallet entity after the update.
application/json
{
  "id": "2e9c4b71-8a5d-4f03-b6e2-1c7d9a0f3e58",
  "object": "wallet_entity",
  "type": "PERSON",
  "status": "PENDING",
  "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": "200 West 2nd St",
    "line_2": null,
    "city": "Austin",
    "state": "TX",
    "postal_code": "78701",
    "country": "US"
  },
  "verification": {
    "status": "IN_REVIEW",
    "submitted_at": "2026-08-27T15:10:00Z",
    "completed_at": null,
    "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-27T15:10: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"
  }
}