Search Account

post

https://example.com/programs/{programCode}/accounts/search

Searches for accounts based on encrypted search criteria. Requires a valid program code and search details in the request body. Returns a list of accounts matching the search parameters.

Path Params

programCode

string

required

Partner program code for the account.

Body Params

The encrypted search criteria for the account. See Gd.Bos.DataTransfer.Request.SearchAccountRequestUnEncrypted for required fields.

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.

version

string | null

The version of the encryption algorithm used to encrypt the data (e.g., "v1", "v2").

ephemeralPublicKey

string | null

The ephemeral public key used in the encryption process, typically for key exchange or session establishment.

publicKeyHash

string | null

The hash of the public key used to verify the integrity and authenticity of the encryption key.

data

string | null

The encrypted data payload, typically base64-encoded, containing the sensitive information.

Headers

X-GD-RequestId

string

required

Unique request tracking identifier (X-GD-RequestId header).

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Responses

401

Unauthorized

200OK

403Forbidden

500Internal Server Error

503Service Unavailable