GetCustomerInfoRequest class

Request for retrieving customer KYC information and status.

Use this request to check what information an anchor requires for a customer, or to verify the current status of a customer's KYC process.

Constructors

GetCustomerInfoRequest()

Properties

account ↔ String?

(deprecated, optional) The server should infer the account from the sub value in the SEP-10 or SEP-45 JWT to identify the customer. This parameter is only used for backwards compatibility, and if explicitly provided in the request body it should match the sub value of the decoded SEP-10 or SEP-45 JWT. Supported account formats: G... (standard), M... (muxed), or C... (contract) accounts.

getter/setter pair

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ String?

(optional) The ID of the customer as returned in the response of a previous PUT request. If the customer has not been registered, they do not yet have an id.

getter/setter pair

jwt ↔ String?

JWT token previously received from the anchor via the SEP-10 or SEP-45 authentication flow.

getter/setter pair

lang ↔ String?

(optional) Language code specified using ISO 639-1. Defaults to 'en'. Human readable descriptions, choices, and messages should be in this language.

getter/setter pair

memo ↔ String?

(optional) A properly formatted memo that uniquely identifies a customer. This value is generated by the client making the request. This parameter and memo_type are identical to the PUT request parameters of the same name.

getter/setter pair

memoType ↔ String?

(deprecated, optional) 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.

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

transactionId ↔ String?

(optional) The transaction id with which the customer's info is associated. Use when information from the customer depends on the transaction (e.g., more information is required for larger amounts).

getter/setter pair

type ↔ String?

(optional) The type of action the customer is being KYC'd for. Examples: 'sep6-deposit', 'sep6-withdraw', 'sep31-sender', 'sep31-receiver' See the Type Specification.

getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited