Retrieve KYC documents

Request

Retrieves a list of KYC documents.
Security
SecretApiKey or JWT
Query
limitinteger, [ 0 .. 1000 ]

Limit the number of collection items to be returned. Use 0 to return an empty collection and still receive the count of matching items in Pagination-Total.

offsetinteger, [ 0 .. 1000 ]
Specifies the starting point within the collection of items to be returned.
filterstring

Criteria for filtering collection items. This field requires a special format. Use , to specify multiple allowed values. Use ; to specify multiple fields.

For more information, see Search filters.

sortArray 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 ,.

expandstring

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 Embedded resources.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/kyc-documents?limit=0&offset=0&filter=string&sort=string&expand=string' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

List of KYC documents retrieved.
Headers
Pagination-Totalinteger

Total number of items that match the request. The value is independent of limit, including when limit is 0.

Example:332
Pagination-Limitinteger
Maximum number of items per page.
Example:100
Pagination-Offsetinteger

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
Bodyapplication/json
Array [
idstring, <= 50 charactersread-only
ID of the KYC document.
Example:"kyc_doc_0YV7JHY705C6DA487BFTAA33V8"
fileIdsArray of stringsrequired

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'].

Permitted file types for identity-proof files: .jpg, .png, and .pdf.

documentTypestring(KycDocumentTypes)required
Document type submitted for validation. Only the `identity-proof` and `address-proof` types are analyzed automatically.
Enum:"identity-proof""address-proof""funds-proof""purchase-proof""credit-file-proof"
Discriminator
documentSubtypestring 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"
statusstringread-onlyrequired
Status of the validation.
Enum ValueDescription
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.
rejectionReasonobject or null(KycDocumentRejection)read-only
Reason the document is rejected.
requestIdstring or null, <= 50 charactersread-only
ID of the KYC request.
Example:"4f6cf35x-2c4y-483z-a0a9-158621f77a21"
createdTimestring, (date-time)(CreatedTime)read-only
Date and time when the resource is created. This value is set automatically when the resource is created.
updatedTimestring, (date-time)(UpdatedTime)read-only
Date and time when the resource is updated. This value is set automatically when the resource is updated.
processedTimestring or null, (date-time)read-only
Date and time when the KYC document is processed.
customerIdstring, <= 50 characters(CustomerId)required
ID of the customer resource.
Example:"cus_0YV7DDSDD1C8DA64KHH2W33CPF"
reviewerIdstring or null, <= 50 charactersread-only
ID of the KYC document reviewer.
Example:"44433322-2c4y-483z-a0a9-158621f77a21"
reviewerNamestring or nullread-only
First and last name of the KYC document reviewer.
reviewStartTimestring or null, (date-time)read-only
Date and time when the manual review starts.
reviewTimestring or null, (date-time)read-only
Date and time of manual review.
notesstring or null
Reviewer notes.
tagsArray of objects(Tag)read-only
List of KYC document tags.
reasonstring or null
Reason for uploading.
matchLevelinteger(KycDocumentMatchLevels)
Document verification level.
Default:2
Enum ValueDescription
1
Moderate verification requirements. This option is used for sale transactions.
2
Strict verification requirements. This option is used for credit transactions.
3
Basic verification requirements. This option is used when a high level of verification is not required.
revisionintegerread-only
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.
documentMatchesobject or nullread-only
Proof of identity document matches.
parsedDataobject or nullread-only
Parsed data.
settingsKycSettingsIdentity (object) or nullread-only
One of:
Identity proof settings.
_linksArray of objectsread-only
Related links.
_embeddedobjectread-only

Embedded objects that are requested by the expand query parameter.

]
Response
[
  {
    "id": "kyc_doc_0YV7JHY705C6DA487BFTAA33V8",
    "fileIds": [ … ],
    "documentType": "identity-proof",
    "documentSubtype": "passport",
    "status": "pending",
    "rejectionReason": { … },
    "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",
    "tags": [ … ],
    "reason": "string",
    "matchLevel": 1,
    "revision": 0,
    "documentMatches": { … },
    "parsedData": { … },
    "settings": { … },
    "_links": [ … ],
    "_embedded": { … }
  }
]