PutCustomerInfoRequest
in package
Request parameters for submitting or updating customer information via SEP-12
This class represents the request payload for submitting customer KYC information to the anchor's SEP-12 endpoint. It is used to register new customers, update existing customer data, or provide additional information requested by the anchor.
The request can include standard KYC fields (name, address, date of birth, etc.) as defined in SEP-9, as well as custom fields specific to the anchor's requirements. File uploads such as ID scans or proof of address documents can also be included.
Customers can be identified by an anchor-assigned ID from a previous submission, or by their Stellar account with optional memo for shared accounts. When updating information, the customer ID should be provided to ensure the correct record is updated.
Tags
Table of Contents
Properties
- $account : string|null
- $customFields : array<string|int, mixed>|null
- $customFiles : array<string|int, string>|null
- $id : string|null
- $jwt : string|null
- $KYCFields : StandardKYCFields|null
- $memo : string|null
- $memoType : string|null
- $transactionId : string|null
- $type : string|null
Properties
$account
public
string|null
$account
= null
(deprecated) This field should match the sub value of the decoded SEP-10 JWT.
$customFields
public
array<string|int, mixed>|null
$customFields
= null
$customFiles
public
array<string|int, string>|null
$customFiles
= null
Custom files that you can use for transmission (fieldname, value-bytes)
$id
public
string|null
$id
= null
The id value returned from a previous call to this endpoint. If specified, no other parameter is required.
$jwt
public
string|null
$jwt
= null
jwt token previously received from the anchor via the SEP-10 authentication flow
$KYCFields
public
StandardKYCFields|null
$KYCFields
= null
kyc data.
$memo
public
string|null
$memo
= null
the client-generated memo that uniquely identifies the customer. If a memo is present in the decoded SEP-10 JWT's sub value, it must match this parameter value. If a muxed account is used as the JWT's sub value, memos sent in requests must match the 64-bit integer subaccount ID of the muxed account. see: https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#shared-omnibus-or-pooled-accounts
$memoType
public
string|null
$memoType
= null
(deprecated) type of memo. One of text, id or hash. Deprecated because memos should always be of type id, although anchors should continue to support this parameter for outdated clients. If hash, memo should be base64-encoded. If a memo is present in the decoded SEP-10 JWT's sub value, this parameter can be ignored. see: https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#shared-omnibus-or-pooled-accounts
$transactionId
public
string|null
$transactionId
= null
The transaction id with which the customer's info is associated. When information from the customer depends on the transaction (e.g., more information is required for larger amounts)
$type
public
string|null
$type
= null
the type of action the customer is being KYCd for. See the Type Specification here: https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#type-specification