Developer docs
/
Rebilly API
/
KYC documents
/
Retrieve KYC documents

Retrieve KYC documents

Retrieves a list of KYC documents.

SecurityAPI Key: SecretApiKey or HTTP: JWT
Request
query Parameters
limit
integer [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offset
integer [ 0 .. 1000 ]

Specifies the starting point within the collection of items to be returned.

filter
string

Filters the collection items. This field requires a special format. Use , for multiple allowed values. Use ; for multiple fields.

For more information, see Using filter with collections.

sort
Array of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -. Multiple fields can be sorted by separating each with ,.

expand
string

Expands a request to include embedded objects within the _embedded property of the response. This field accepts a comma-separated list of objects.

For more information, see Expand to include embedded objects.

get
/kyc-documents
Request samples
// all parameters are optional
const firstCollection = await api.kycDocuments.getAll();

// alternatively you can specify one or more of them
const params = {limit: 20, offset: 100, sort: '-createdTime'};
const secondCollection = await api.kycDocuments.getAll(params);

// access the collection items, each item is a Member
secondCollection.items.forEach(document => console.log(document.fields.documentType));
Responses

200

List of KYC documents retrieved.

Response Headers
Pagination-Total
integer

Total number of items.

Example: 332
Pagination-Limit
integer

Maximum number of items per page.

Example: 100
Pagination-Offset
integer

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example: 2
Response Schema: application/json
Array
id
string <= 50 characters

ID of the KYC document.

fileIds
required
Array of strings

IDs of linked file objects.

Uploaded identity-proof files must have the following tags attached to be used for KYC purposes: ['kyc', 'id-front'], ['kyc', 'id-back'], ['kyc', 'face-proof'].

documentType
required
string (KycDocumentTypes)

Document type submitted for validation. Only the identity-proof and address-proof types are analyzed automatically.

documentSubtype
string or null (KycDocumentSubtypes)

Document subtype submitted for validation.

Enum: "passport" "id-card" "driver-license" "birth-certificate" "utility-bill" "rental-receipt" "lease-agreement" "copy-credit-card" "credit-card-statement" "bank-statement" "inheritance-documentation" "tax-return" "salary-slip" "sale-of-assets" "public-health-card" "proof-of-age-card" "reverse-of-id" "public-service" "ewallet-holder-details" "ewallet-transaction-statement" "marriage-certificate" "firearms-license" "insurance-letter" "income-statement" "debtors-letter" "other" null
status
required
string

Status of the validation.

Enum Value Description
pending

Waiting to be reviewed or analyzed.

in-progress

Being analyzed by the Rebilly AI.

accepted

Accepted by AI or a human.

rejected

Rejected by AI or a human.

archived

Archived by the Rebilly AI.

object or null (KycDocumentRejection)

Reason the document is rejected.

requestId
string or null <= 50 characters

ID of the KYC request.

createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

processedTime
string or null <date-time>

Date and time when the KYC document is processed.

customerId
required
string (CustomerId) <= 50 characters

ID of the customer resource.

reviewerId
string or null <= 50 characters

ID of the KYC document reviewer.

reviewerName
string or null

First and last name of the KYC document reviewer.

reviewStartTime
string or null <date-time>

Date and time when the manual review starts.

reviewTime
string or null <date-time>

Date and time of manual review.

notes
string or null

Reviewer notes.

Array of objects (Tag)

List of KYC document tags.

reason
string or null

Reason for uploading.

matchLevel
integer [ 1 .. 2 ]

Tolerance level setting for document matches.

revision
integer

Number of times the KYC document data has been modified.

Use this value when analyzing webhook data to determine if a change must take precedence over the current representation.

object or null

Proof of identity document matches.

object or null

Parsed data.

KycSettingsIdentity (object) or null

Settings used to score the document.

Array of objects

Related links.

object

Embedded objects that are requested by the expand query parameter.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

Response samples
application/json
[
{
"id": "kyc_doc_0YV7JHY705C6DA487BFTAA33V8",

"documentType": "identity-proof",
"documentSubtype": "passport",
"status": "pending",

"requestId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
"createdTime": "2019-08-24T14:15:22Z",
"updatedTime": "2019-08-24T14:15:22Z",
"processedTime": "2019-08-24T14:15:22Z",
"customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF",
"reviewerId": "44433322-2c4y-483z-a0a9-158621f77a21",
"reviewerName": "string",
"reviewStartTime": "2019-08-24T14:15:22Z",
"reviewTime": "2019-08-24T14:15:22Z",
"notes": "string",

"reason": "string",
"matchLevel": 2,
"revision": 0,





}
]