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.
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.
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.
- Mock serverhttps://www.rebilly.com/_mock/catalog/all/kyc-requests
- Sandbox serverhttps://api-sandbox.rebilly.com/organizations/{organizationId}/kyc-requests
- Live serverhttps://api.rebilly.com/organizations/{organizationId}/kyc-requests
curl -i -X GET \
'https://www.rebilly.com/_mock/catalog/all/kyc-requests?limit=0&offset=0&filter=string&sort=string&expand=string' \
-H 'REB-APIKEY: YOUR_API_KEY_HERE'Total number of items that match the request. The value is independent of limit, including when limit is 0.
| Enum Value | Description |
|---|---|
| gathering | |
| attempted | At least one document has been provided but none were assigned the |
| partial | At least one requested document has the |
| pending-review | At least one requested document has the |
| fulfilled | All requested documents are provided and have been assigned the |
| failed | At least one requested document has exhausted all attempts, and has not been assigned a |
| abandoned | |
| expired |
URL where the customer is redirected when a KYC document upload is complete. When the customer is redirected, Rebilly appends an info query parameter that has one of the following values:
back: Customer clicked theback to websitelink.token_expired: Customer's token expired.success: Customer uploaded KYC documents that have been analyzed.manual: Customer uploaded KYC documents that require a manual review. This is because the analyzer rejected the documents or could not process them.partial: Some of the customer's KYC documents have been analyzed, but other documents have not. For example, this may occur when a proof of address document is analyzed but proof of ID is not.
Example: https://example.com?info=success.
| Enum Value | Description |
|---|---|
| 1 | |
| 2 | |
| 3 |
{ "identityProof": [ "driver-license", "public-health-card" ] }
[ { "id": "kyc_req_0YV7JMJ3DBCGRBR7K9D4HVGPP5", "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF", "documents": [ … ], "status": "gathering", "redirectUrl": "http://example.com", "reason": "spend limit", "matchLevel": 1, "revision": 0, "subtypeRestrictions": { … }, "subtypeRestrictionUiEnabled": true, "expirationTime": "2019-08-24T14:15:22Z", "createdTime": "2019-08-24T14:15:22Z", "updatedTime": "2019-08-24T14:15:22Z", "_links": [ … ], "_embedded": { … } } ]