GetCustomerInfoProvidedField
extends Response
in package
Represents a KYC field that has been provided by the customer and its verification status.
This object contains information about fields the anchor has already received from the customer. Each field includes its verification status indicating whether it has been accepted, rejected, or requires verification. This is particularly important for fields that need verification via the customer verification endpoint.
Field status values:
- ACCEPTED: The field has been validated and accepted by the anchor.
- PROCESSING: The field is being reviewed and has not yet been approved or rejected.
- REJECTED: The field was rejected and the error property explains why.
- VERIFICATION_REQUIRED: The field needs additional verification (e.g., confirmation code).
Tags
Table of Contents
Properties
- $choices : array<string|int, string>|null
- $description : string|null
- $error : string|null
- $optional : bool
- $status : string|null
- $type : string
- $httpClient : Client|null
- $rateLimitLimit : int|null
- $rateLimitRemaining : int|null
- $rateLimitReset : int|null
Methods
- fromJson() : GetCustomerInfoProvidedField
- getChoices() : array<string|int, string>|null
- getDescription() : string|null
- getError() : string|null
- getHttpClient() : Client|null
- Gets the HTTP client used for pagination requests
- getRateLimitLimit() : int|null
- Returns X-RateLimit-Limit header from the response.
- getRateLimitRemaining() : int|null
- Returns X-RateLimit-Remaining header from the response.
- getRateLimitReset() : int|null
- Returns X-RateLimit-Reset header from the response. Seconds until a new window starts.
- getStatus() : string|null
- getType() : string
- isOptional() : bool
- setHeaders() : void
- Extracts and sets rate limiting information from HTTP response headers
- setHttpClient() : void
- Sets the HTTP client for making follow-up requests
- loadFromJson() : void
- Loads response data from a JSON array
Properties
$choices
public
array<string|int, string>|null
$choices
= null
An array of valid values for this field.
$description
public
string|null
$description
= null
A human-readable description of this field, especially important if this is not a SEP-9 field.
$error
public
string|null
$error
= null
The human-readable description of why the field is REJECTED.
$optional
public
bool
$optional
= false
A boolean whether this field is required to proceed or not. Defaults to false.
$status
public
string|null
$status
= null
One of the values described here: https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#field-statuses If the server does not wish to expose which field(s) were accepted or rejected, this property will be omitted.
$type
public
string
$type
The data type of the field value. Can be "string", "binary", "number", or "date".
$httpClient
protected
Client|null
$httpClient
= null
$rateLimitLimit
protected
int|null
$rateLimitLimit
= null
$rateLimitRemaining
protected
int|null
$rateLimitRemaining
= null
$rateLimitReset
protected
int|null
$rateLimitReset
= null
Methods
fromJson()
public
static fromJson(array<string|int, mixed> $json) : GetCustomerInfoProvidedField
Parameters
- $json : array<string|int, mixed>
Return values
GetCustomerInfoProvidedFieldgetChoices()
public
getChoices() : array<string|int, string>|null
Return values
array<string|int, string>|nullgetDescription()
public
getDescription() : string|null
Return values
string|nullgetError()
public
getError() : string|null
Return values
string|nullgetHttpClient()
Gets the HTTP client used for pagination requests
public
getHttpClient() : Client|null
Return values
Client|null —The HTTP client instance, or null if not set
getRateLimitLimit()
Returns X-RateLimit-Limit header from the response.
public
getRateLimitLimit() : int|null
This number represents the he maximum number of requests that the current client can make in one hour.
Tags
Return values
int|nullgetRateLimitRemaining()
Returns X-RateLimit-Remaining header from the response.
public
getRateLimitRemaining() : int|null
The number of remaining requests for the current window.
Tags
Return values
int|nullgetRateLimitReset()
Returns X-RateLimit-Reset header from the response. Seconds until a new window starts.
public
getRateLimitReset() : int|null
Tags
Return values
int|nullgetStatus()
public
getStatus() : string|null
Return values
string|nullgetType()
public
getType() : string
Return values
stringisOptional()
public
isOptional() : bool
Return values
boolsetHeaders()
Extracts and sets rate limiting information from HTTP response headers
public
setHeaders(array<string|int, mixed> $headers) : void
This method processes the X-Ratelimit-* headers from the HTTP response and stores them for client access.
Parameters
- $headers : array<string|int, mixed>
-
Associative array of HTTP headers from the response
setHttpClient()
Sets the HTTP client for making follow-up requests
public
setHttpClient([Client|null $httpClient = null ]) : void
Paginated responses contain links to next/previous pages. This HTTP client is used when following those links to fetch additional pages.
Parameters
- $httpClient : Client|null = null
-
The Guzzle HTTP client to use for pagination
loadFromJson()
Loads response data from a JSON array
protected
loadFromJson(array<string|int, mixed> $json) : void
This method is used internally to populate response objects from parsed JSON. Subclasses override this to extract their specific data fields.
Parameters
- $json : array<string|int, mixed>
-
Associative array of parsed JSON data