API Reference

Update User Name

put
https://example.com/programs//accounts//users//name

Updates the legal name of a user due to a legal event such as marriage, divorce, or court order. Requires supporting documentation and may trigger card re-issuance and CRM case creation.

Path Params
string
required

The unique identifier of the user whose name is being updated. Must be a valid GUID.

string
required

The unique identifier of the account associated with the user. Must be a valid GUID.

string
required

The program code associated with the request.

Body Params

The Gd.Bos.DataTransfer.Request.UpdateUserNameRequestEncrypted object containing the new legal name and supporting documentation.

encryptedUserData
object

Represents a container for encrypted data used in secure data transfer operations. Contains the encrypted payload and associated cryptographic metadata, including encryption version, ephemeral public key, and public key hash. Used to securely transmit sensitive information such as user data, ensuring confidentiality and integrity during transport.

Headers
string
required

The unique request identifier for idempotency and tracking. Must be provided in the X-GD-RequestId header.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Unauthorized

Updated 2 months ago

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json
text/json

Updated 2 months ago