🚀 VaultsPay API v1 is live. See what's new →
Payment CardsEmbossing Name Options

Embossing Name Options

Returns a list of embossing name possibilities for a given user based on their legal name and internal formatting rules.

This endpoint runs an internal algorithm that generates allowed embossing variants (accommodating length, special-character rules, initials, etc.). When creating a card you must choose one of the names from this list — submitting any other embossing name in the create-card request will cause card creation to fail.

Limitations / Notes:

  • The list is authoritative for embossing only and may include shortened, initialled, or alternate forms.
  • The endpoint does not modify user data; it only suggests allowed embossing names.
  • The length and permitted characters follow card manufacturer / network constraints which are enforced downstream.
GET{gateway}/pcs/api/v1/embossing-names/{userId}

Payload

AttributeTypeDescriptionRequired
userIdIntegerPath parameter — ID of the user for whom embossing names are to be generated.Yes

Response

AttributeTypeDescription
dataObjectWrapper object for response data.
data.namesArray<String>Array of allowed embossing name strings.
200 — SUCCESS
{
  "data": {
    "names": [
      "SUPER",
      "SUPER ADMIN",
      "SUPER A",
      "S ADMIN"
    ]
  }
}
422 — FAILED
{
  "code": 1000,
  "message": "Invalid payload. Please check your request.",
  "type": "INVALID_PAYLOAD",
  "errors": [
    {
      "key": "id",
      "reason": "User does not exist with this id"
    }
  ]
}