The collection items filter requires a special format.
Use "," for multiple allowed values. Use ";" for multiple fields.
See the filter guide for more options and examples about this format.
sort
Array of strings
The collection items sort field and order (prefix with "-" for descending sort).
Responses
200
A list of KYC requests was retrieved successfully.
Enum:"passport""id-card""driver-license""birth-certificate""utility-bill""rental-receipt""lease-agreement""copy-credit-card""credit-card-statement""bank-statement"… 11 more
maxAttempts
integer [ 0 .. 100 ]
Default: 3
Total number of allowed document upload attempts. Use 0 to allow unlimited upload attempts.
faceProofRequired
boolean
Specifies whether the customer must upload a photo of their face (selfie) that matches a provided KYC document.
customerId
required
string (CustomerId) <= 50 characters
The customer resource ID. Defaults to UUID v4.
id
string <= 50 characters
The resource ID. Defaults to UUID v4.
status
string
Status of the request.
Enum:
Description
gathering
No documents have been provided yet. Temporary state.
attempted
At least one document has been provided but is not accepted. Temporary state.
partial
At least one requested document has the accepted status, but not all of them. Temporary state.
pending-review
At least one document type has a document with the pending status and no documents with the accepted status. Temporary state (until reviewed or another accepted document is provided).
fulfilled
All requested documents are provided and accepted. Permanent state.
failed
At least one requested document exhausted all attempts and does not have the status accepted, pending or in-progress. Permanent state.
abandoned
Request expired and has at least one document provided. Permanent state.
expired
Request expired without any document uploaded. Permanent state.
redirectUrl
string <uri>
The URL to redirect the customer when an upload is completed.
When the customer is redirected, Rebilly will append an info query parameter which may have one of the following values (example: https://example.com?info=success):
back - The customer clicked the back to website link;
token_expired - The customer's token expired;
success - The customer uploaded docs that were successfully analyzed;
manual - The customer uploaded docs that will require manual review because the analyzer rejected them or couldn't process them;
partial - The customer had success with some doc type but not with other (for example, successful proof of address but skipped proof of id).
expirationTime
string <date-time>
Expiration date-time. Default value is one hour in the future.
createdTime
string <date-time>
Creation date-time.
updatedTime
string <date-time> (UpdatedTime)
Read-only timestamp updates when the resource is updated.
reason
string
Reason for uploading.
matchLevel
integer [ 1 .. 2 ]
Default: 2
The level of strictness for the document matches.
The value of 1 is less strict and 2 is strict.
revision
integer
The number of times the KYC request data has been modified. The revision is useful when analyzing webhook data to determine if the change takes precedence over the current representation.
Array of Self (object) or KycDocumentsLink (object) or KycGathererLink (object) non-empty
The links related to the resource.
Array (non-empty)
Any of:
href
required
string
The link URL.
rel
required
string
The link type.
Value:"self"
object
Any embedded objects available that are requested by the expand querystring parameter.
Array of objects (KycDocument)
401
Unauthorized access, invalid credentials were used.
