The Rebilly API is built on HTTP and is RESTful. It has predictable resource URLs and returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. Use your favorite HTTP/REST library in your programming language when using this API, or use one of the Rebilly SDKs, which are available in PHP and JavaScript.
Every action in the Rebilly UI is supported by an API which is documented and available for use, so that you may automate any necessary workflows or processes. This API reference documentation contains the most commonly integrated resources.
This topic describes the different forms of authentication that are available in the Rebilly API, and how to use them.
Rebilly offers four forms of authentication: secret key, publishable key, JSON Web Tokens, and public signature key.
To create or manage API keys, select one of the following:
For more information on API keys, see API keys.
Rebilly follows the error response format proposed in RFC 9457, which is also known as Problem Details for HTTP APIs. As with any API responses, your client must be prepared to gracefully handle additional members of the response.
Rebilly provides a JavaScript SDK and a PHP SDK to help interact with the Rebilly API. However, no SDK is required to use the API.
Rebilly also provides FramePay, a client-side iFrame-based solution, to help create payment tokens while minimizing PCI DSS compliance burdens and maximizing your customization ability. FramePay interacts with the payment tokens creation operation.
For installation and usage instructions, see SDKs. All JavaScript SDK code examples are included in the API reference documentation.
For installation and usage instructions, see SDKs. All SDK code examples are included in the API reference documentation. To use them, you must configure the $client as follows:
$client = new Rebilly\Client([ 'apiKey' => 'YourApiKeyHere', 'baseUrl' => 'https://api.rebilly.com', ]);
The full Rebilly API has over 500 operations. This is likely more than you may need to implement your use cases. If you would like to implement a particular use case, contact Rebilly for guidance and feedback on the best API operations to use for the task.
To integrate Rebilly, and learn about related resources and concepts, see Get started.
Use these operations to manage customers. A customer is an entity that purchases goods or services from you (a merchant), and is the payee in any transaction that is credited to you. Customers are associated with payment instruments, subscriptions, invoices, and other related resources.
In other systems, customers may be referred to as accounts, clients, members, patrons, or players. For information on the customer resource, see Resources.
Use these operations to manage payment instruments. Payment instrument is a term which describes any means of making a digital payment, such as: credit cards, debit cards, direct debits, payment service providers, and digital wallets.
For more information on payment instruments, see Payment instruments.
Use payment tokens to reduce the scope of PCI DSS compliance.
A payment token can be made using a different authentication scheme (public key authentication), which enables you to create a payment token directly from the browser. This bypasses the need to send sensitive cardholder info to your servers. We recommend using this with the FramePay library, which helps you integrate a form into this API resource and create payment tokens.
Use these operations to manage disputes. A dispute occurs when a customer contests a charge to their account. The dispute and related information is made available to the merchant by the bank or credit card company. The merchant then has the option to represent the charge and win the case. This process is called dispute resolution. If the merchant is unable to represent the charge, the card issuer typically reverses the sale and adds fees on top of the charge. This process is called a chargeback.
Use these operations to manage customer orders. An order is a customer's request to purchase items. It can contain subscription and one-time sale items. When an order contains one or more subscription items, it is a subscription order.
An order generates an invoice. A subscription order generates an invoice for each service period. For more information, see Orders.
Use these operations to manage the product usage of a subscription item for metered billing purposes.
Use metered billing when product quantity is unknown to the customer at the moment of creating a subscription. Metered billing is based on reported usage records. Every reported usage updates the quantity of an upcoming invoice item for a specified subscription and a plan. To create a metered billing plan, see Plans.
Use credit memos to provide a customer with store credit. A common use case for using a credit memo is to provide a customer with store credit, rather than a refund, if the customer pays more than they owe or returns a product. For information on the credit memo resource, see Resources.
Use pricing plans to describe how the customer must pay for products.
Rebilly provides the following plan types:
For information on the plans resource, see Plans.
For information on plan pricing, see Pricing formulas.
Use coupons to reward customers, generate sales, or to test new pricing strategies. Coupons enable you to apply different types of discounts to invoices, subscriptions, and pricing plans.
Redeemed coupons are attached to a customer's account. Depending on the coupon restrictions, the redeemed coupons are then applied from the customer's account to subsequent invoices or subscriptions. Redeemed coupons can only be applied to invoices of the same currency.
Once a coupon is redeemed it cannot be modified. You may deactivate a coupon or create a new coupon, but you cannot reuse the same coupon code. If you have a use case where you must reuse the same code, contact Rebilly.
Use quote operations to create and manage quotations. Quotations describe the cost of goods or services to potential customers before they commit to a purchase. A quote contains an initial invoice preview that can be accepted to become an order.
A quote can contain subscription and one-time sale items. When a quote contains one or more subscription items, it is a subscription order quote.
Use blocklists to prevent fraud and criminal activity.
Blocklists are lists of customer attribute values that are blocked from buying from you. For example, if a customer attempts to make a purchase from you with a credit card that is in a blocklist, the transaction is blocked and is not processed.
Before a new transaction is processed in Rebilly, blocklists are examined to check for attributes related to the entity. If a match is detected, the operation is aborted. A blocklist that expires after a period of time is called a greylist.
Use allowlists to exclude specific customer attribute data from risk score checks.
Allowlists are lists of data that are excluded from risk score checks. Allowlists prevent specific data from being added to a blocklist record when a risk score threshold reached.
Use Know Your Customer (KYC) documents to verify your customers identity. The KYC document operations generate a signed link to the Rebilly KYC document gatherer.
Document types:
identity-proof: Validates a customer's identity.address-proof: Validates a customer's address.purchase-proof: Validates a customer's purchase.funds-proof: Validates that a customer has funds.credit-file-proof: Verifies that there is an existing credit file with two sources that match the customer's name, DOB, and address.Rebilly parses and analyzes the documents and accepts or rejects them according to a configurable scoring algorithm. When all document types in a KYC request are accepted, the status is fulfilled, and the KYC request fulfilled webhook is sent.
The credit-file-proof KYC document request type is only available in the API, this option is not available in the KYC document gatherer. This request verifies that there is an existing credit file with two sources that match the person's name, date of birth, and address.
In Canada, to meet FINTRAC requirements, the credit-file-proof KYC document request verifies the customer's name, address, and date of birth with a credit agency.
If credit-file-proof is requested in combination with identity-proof and address-proof, credit-file-proof is attempted first. If credit-file-proof validates the identity and address, the KYC request is considered fulfilled. If the request is not fulfilled, redirect your customer to the KYC document gatherer to collect their KYC documents.
Creates a KYC request.
The customer is redirected to the kycGatherer link. After the customer completes the KYC process, they are redirected back to the redirectUrl link.
Corresponding webhooks, such as: KYC document accepted and KYC document rejected, are sent to the subscribers.
When the complete list of documents is received and accepted, the KYC request fulfilled webhook is sent to subscribers.
If a credit-file-proof request is successful, it returns a decision value of single-source or dual-source. The corresponding identity-proof and address-proof documents are not requested.
KYC request resource.
Documents to request from the customer.
Type of document to request from the customer.
Permitted document subtype.
Total number of allowed document upload attempts. Use 0 to allow unlimited upload attempts.
Specifies if the customer must upload a photo of their face (selfie) that matches a provided KYC document.
Specifies if the customer must use the face liveness feature when uploading a selfie. For more information, see Facial recognition and identity verification.
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 the back to website link.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.
Tolerance level setting for document matches. The value of 1 is more tolerant and 2 is strict.
curl -i -X POST \ https://www.rebilly.com/_mock/docs/dev-docs/api/kyc-requests \ -H 'Content-Type: application/json' \ -H 'REB-APIKEY: YOUR_API_KEY_HERE' \ -d '{ "customerId": "123_456789", "redirectUrl": "https://example.com/return-here/", "documents": [ { "type": "credit-file-proof", "maxAttempts": 1 }, { "type": "identity-proof" }, { "type": "address-proof" } ], "reason": "registration" }'
KYC request created.
ID of the KYC request.
"kyc_req_0YV7JMJ3DBCGRBR7K9D4HVGPP5"
Documents to request from the customer.
Type of document to request from the customer.
Permitted document subtype.
Total number of allowed document upload attempts. Use 0 to allow unlimited upload attempts.
Specifies if the customer must upload a photo of their face (selfie) that matches a provided KYC document.
Specifies if the customer must use the face liveness feature when uploading a selfie. For more information, see Facial recognition and identity verification.
Status of the request.
| Enum Value | Description |
|---|---|
| gathering | No documents have been provided yet. This is a temporary state. |
| 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 | One or more documents provided but the request expired. This is a permanent state. |
| expired | No documents were provided and the request expired. This is a permanent state. |
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 the back to website link.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.
Tolerance level setting for document matches. The value of 1 is more tolerant and 2 is strict.
Number of times the KYC request data has been modified.
Use this value when analyzing webhook data to determine if a change must take precedence over the current representation.
Date and time when the request expires. The default value is one hour in the future.
Date and time which is set automatically when the resource is created.
Date and time which updates automatically when the resource is updated.
{ "id": "kyc_req_0YV7JMJ3DBCGRBR7K9D4HVGPP5", "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF", "documents": [ { … } ], "status": "gathering", "redirectUrl": "http://example.com", "reason": "spend limit", "matchLevel": 2, "revision": 0, "expirationTime": "2019-08-24T14:15:22Z", "createdTime": "2019-08-24T14:15:22Z", "updatedTime": "2019-08-24T14:15:22Z", "_links": [ { … } ], "_embedded": { "documents": [] } }
Specifies the starting point within the collection of items to be returned.
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.
curl -i -X GET \ 'https://www.rebilly.com/_mock/docs/dev-docs/api/kyc-requests?filter=string&limit=1000&offset=1000&sort=string' \ -H 'REB-APIKEY: YOUR_API_KEY_HERE'
List of KYC requests retrieved.
ID of the KYC request.
"kyc_req_0YV7JMJ3DBCGRBR7K9D4HVGPP5"
Documents to request from the customer.
Type of document to request from the customer.
Permitted document subtype.
Total number of allowed document upload attempts. Use 0 to allow unlimited upload attempts.
Specifies if the customer must upload a photo of their face (selfie) that matches a provided KYC document.
Specifies if the customer must use the face liveness feature when uploading a selfie. For more information, see Facial recognition and identity verification.
Status of the request.
| Enum Value | Description |
|---|---|
| gathering | No documents have been provided yet. This is a temporary state. |
| 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 | One or more documents provided but the request expired. This is a permanent state. |
| expired | No documents were provided and the request expired. This is a permanent state. |
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 the back to website link.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.
Tolerance level setting for document matches. The value of 1 is more tolerant and 2 is strict.
Number of times the KYC request data has been modified.
Use this value when analyzing webhook data to determine if a change must take precedence over the current representation.
Date and time when the request expires. The default value is one hour in the future.
Date and time which is set automatically when the resource is created.
Date and time which updates automatically when the resource is updated.
[ { "id": "kyc_req_0YV7JMJ3DBCGRBR7K9D4HVGPP5", "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF", "documents": [ … ], "status": "gathering", "redirectUrl": "http://example.com", "reason": "spend limit", "matchLevel": 2, "revision": 0, "expirationTime": "2019-08-24T14:15:22Z", "createdTime": "2019-08-24T14:15:22Z", "updatedTime": "2019-08-24T14:15:22Z", "_links": [ … ], "_embedded": { … } } ]
curl -i -X GET \ 'https://www.rebilly.com/_mock/docs/dev-docs/api/kyc-requests/{id}' \ -H 'REB-APIKEY: YOUR_API_KEY_HERE'
KYC request retrieved.
ID of the KYC request.
"kyc_req_0YV7JMJ3DBCGRBR7K9D4HVGPP5"
Documents to request from the customer.
Type of document to request from the customer.
Permitted document subtype.
Total number of allowed document upload attempts. Use 0 to allow unlimited upload attempts.
Specifies if the customer must upload a photo of their face (selfie) that matches a provided KYC document.
Specifies if the customer must use the face liveness feature when uploading a selfie. For more information, see Facial recognition and identity verification.
Status of the request.
| Enum Value | Description |
|---|---|
| gathering | No documents have been provided yet. This is a temporary state. |
| 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 | One or more documents provided but the request expired. This is a permanent state. |
| expired | No documents were provided and the request expired. This is a permanent state. |
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 the back to website link.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.
Tolerance level setting for document matches. The value of 1 is more tolerant and 2 is strict.
Number of times the KYC request data has been modified.
Use this value when analyzing webhook data to determine if a change must take precedence over the current representation.
Date and time when the request expires. The default value is one hour in the future.
Date and time which is set automatically when the resource is created.
Date and time which updates automatically when the resource is updated.
{ "id": "kyc_req_0YV7JMJ3DBCGRBR7K9D4HVGPP5", "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF", "documents": [ { … } ], "status": "gathering", "redirectUrl": "http://example.com", "reason": "spend limit", "matchLevel": 2, "revision": 0, "expirationTime": "2019-08-24T14:15:22Z", "createdTime": "2019-08-24T14:15:22Z", "updatedTime": "2019-08-24T14:15:22Z", "_links": [ { … } ], "_embedded": { "documents": [] } }
KYC document resource.
Documents to request from the customer.
Type of document to request from the customer.
Permitted document subtype.
Total number of allowed document upload attempts. Use 0 to allow unlimited upload attempts.
Specifies if the customer must upload a photo of their face (selfie) that matches a provided KYC document.
Specifies if the customer must use the face liveness feature when uploading a selfie. For more information, see Facial recognition and identity verification.
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 the back to website link.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.
Tolerance level setting for document matches. The value of 1 is more tolerant and 2 is strict.
curl -i -X PATCH \ 'https://www.rebilly.com/_mock/docs/dev-docs/api/kyc-requests/{id}' \ -H 'Content-Type: application/json' \ -H 'REB-APIKEY: YOUR_API_KEY_HERE' \ -d '{ "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF", "documents": [ { "type": "identity-proof", "subtypes": [ "passport" ], "maxAttempts": 3, "faceProofRequired": true, "faceLivenessRequired": true } ], "redirectUrl": "http://example.com", "reason": "spend limit", "matchLevel": 2, "expirationTime": "2019-08-24T14:15:22Z" }'
KYC request updated.
ID of the KYC request.
"kyc_req_0YV7JMJ3DBCGRBR7K9D4HVGPP5"
Documents to request from the customer.
Type of document to request from the customer.
Permitted document subtype.
Total number of allowed document upload attempts. Use 0 to allow unlimited upload attempts.
Specifies if the customer must upload a photo of their face (selfie) that matches a provided KYC document.
Specifies if the customer must use the face liveness feature when uploading a selfie. For more information, see Facial recognition and identity verification.
Status of the request.
| Enum Value | Description |
|---|---|
| gathering | No documents have been provided yet. This is a temporary state. |
| 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 | One or more documents provided but the request expired. This is a permanent state. |
| expired | No documents were provided and the request expired. This is a permanent state. |
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 the back to website link.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.
Tolerance level setting for document matches. The value of 1 is more tolerant and 2 is strict.
Number of times the KYC request data has been modified.
Use this value when analyzing webhook data to determine if a change must take precedence over the current representation.
Date and time when the request expires. The default value is one hour in the future.
Date and time which is set automatically when the resource is created.
Date and time which updates automatically when the resource is updated.
{ "id": "kyc_req_0YV7JMJ3DBCGRBR7K9D4HVGPP5", "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF", "documents": [ { … } ], "status": "gathering", "redirectUrl": "http://example.com", "reason": "spend limit", "matchLevel": 2, "revision": 0, "expirationTime": "2019-08-24T14:15:22Z", "createdTime": "2019-08-24T14:15:22Z", "updatedTime": "2019-08-24T14:15:22Z", "_links": [ { … } ], "_embedded": { "documents": [] } }
curl -i -X DELETE \ 'https://www.rebilly.com/_mock/docs/dev-docs/api/kyc-requests/{id}' \ -H 'REB-APIKEY: YOUR_API_KEY_HERE'
{ "status": 401, "type": "http://example.com", "title": "string", "detail": "string", "instance": "string" }
Specifies the starting point within the collection of items to be returned.
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.
Sorts and orders the collection of items. To sort in descending order, prefix with -. Multiple fields can be sorted by separating each with ,.
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.
curl -i -X GET \ 'https://www.rebilly.com/_mock/docs/dev-docs/api/kyc-documents?expand=string&filter=string&limit=1000&offset=1000&sort=string' \ -H 'REB-APIKEY: YOUR_API_KEY_HERE'
List of KYC documents retrieved.
ID of the KYC document.
"kyc_doc_0YV7JHY705C6DA487BFTAA33V8"
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'].
["file_0YV7HZ7KDCC5WBV9Q7WRKG1H6N"]
Document type submitted for validation. Only the identity-proof and address-proof types are analyzed automatically.
Document subtype submitted for validation.
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. |
ID of the KYC request.
"4f6cf35x-2c4y-483z-a0a9-158621f77a21"
Date and time which is set automatically when the resource is created.
Date and time which updates automatically when the resource is updated.
ID of the KYC document reviewer.
"44433322-2c4y-483z-a0a9-158621f77a21"
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.
Settings used to score the document.
Settings used to score the document.
[ { "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": 2, "revision": 0, "documentMatches": { … }, "parsedData": { … }, "settings": { … }, "_links": [ … ], "_embedded": { … } } ]
Kyc document resource.
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'].
["file_0YV7HZ7KDCC5WBV9Q7WRKG1H6N"]
Document type submitted for validation. Only the identity-proof and address-proof types are analyzed automatically.
Document subtype submitted for validation.
curl -i -X POST \ https://www.rebilly.com/_mock/docs/dev-docs/api/kyc-documents \ -H 'Content-Type: application/json' \ -H 'REB-APIKEY: YOUR_API_KEY_HERE' \ -d '{ "fileIds": [ "file_0YV7HZ7KDCC5WBV9Q7WRKG1H6N" ], "documentType": "identity-proof", "documentSubtype": "passport", "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF", "notes": "string", "reason": "string", "matchLevel": 2, "settings": { "weights": { "containsImage": 100, "isIdentityDocument": 100, "isPublishedOnline": 100, "firstName": 100, "lastName": 100, "expirationDate": 100, "dateOfBirth": 100, "matchesDateOfBirth": 100, "issueDate": 100, "hasMinimalAge": 100, "hasMatchingFaceProof": 100, "nationality": 100, "documentSubtype": 100, "isTampered": 100 }, "thresholds": { "rejectBelow": 100, "acceptAbove": 100 } } }'
KYC document created.
ID of the KYC document.
"kyc_doc_0YV7JHY705C6DA487BFTAA33V8"
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'].
["file_0YV7HZ7KDCC5WBV9Q7WRKG1H6N"]
Document type submitted for validation. Only the identity-proof and address-proof types are analyzed automatically.
Document subtype submitted for validation.
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. |
ID of the KYC request.
"4f6cf35x-2c4y-483z-a0a9-158621f77a21"
Date and time which is set automatically when the resource is created.
Date and time which updates automatically when the resource is updated.
ID of the KYC document reviewer.
"44433322-2c4y-483z-a0a9-158621f77a21"
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.
Settings used to score the document.
Settings used to score the document.
{ "id": "kyc_doc_0YV7JHY705C6DA487BFTAA33V8", "fileIds": [ "file_0YV7HZ7KDCC5WBV9Q7WRKG1H6N" ], "documentType": "identity-proof", "documentSubtype": "passport", "status": "pending", "rejectionReason": { "type": "document-unreadable", "message": "Provided document is unreadable" }, "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": 2, "revision": 0, "documentMatches": { "score": 0.75, "data": { … } }, "parsedData": { "score": 0.75, "data": { … } }, "settings": { "weights": { … }, "thresholds": { … } }, "_links": [ { … } ], "_embedded": { "customer": {}, "files": [] } }
curl -i -X GET \ 'https://www.rebilly.com/_mock/docs/dev-docs/api/kyc-documents/{id}' \ -H 'REB-APIKEY: YOUR_API_KEY_HERE'
KYC document retrieved.
ID of the KYC document.
"kyc_doc_0YV7JHY705C6DA487BFTAA33V8"
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'].
["file_0YV7HZ7KDCC5WBV9Q7WRKG1H6N"]
Document type submitted for validation. Only the identity-proof and address-proof types are analyzed automatically.
Document subtype submitted for validation.
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. |
ID of the KYC request.
"4f6cf35x-2c4y-483z-a0a9-158621f77a21"
Date and time which is set automatically when the resource is created.
Date and time which updates automatically when the resource is updated.
ID of the KYC document reviewer.
"44433322-2c4y-483z-a0a9-158621f77a21"
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.
Settings used to score the document.
Settings used to score the document.
{ "id": "kyc_doc_0YV7JHY705C6DA487BFTAA33V8", "fileIds": [ "file_0YV7HZ7KDCC5WBV9Q7WRKG1H6N" ], "documentType": "identity-proof", "documentSubtype": "passport", "status": "pending", "rejectionReason": { "type": "document-unreadable", "message": "Provided document is unreadable" }, "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": 2, "revision": 0, "documentMatches": { "score": 0.75, "data": { … } }, "parsedData": { "score": 0.75, "data": { … } }, "settings": { "weights": { … }, "thresholds": { … } }, "_links": [ { … } ], "_embedded": { "customer": {}, "files": [] } }
KYC document resource.
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'].
["file_0YV7HZ7KDCC5WBV9Q7WRKG1H6N"]
Document type submitted for validation. Only the identity-proof and address-proof types are analyzed automatically.
Document subtype submitted for validation.
curl -i -X PUT \ 'https://www.rebilly.com/_mock/docs/dev-docs/api/kyc-documents/{id}' \ -H 'Content-Type: application/json' \ -H 'REB-APIKEY: YOUR_API_KEY_HERE' \ -d '{ "fileIds": [ "file_0YV7HZ7KDCC5WBV9Q7WRKG1H6N" ], "documentType": "identity-proof", "documentSubtype": "passport", "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF", "notes": "string", "reason": "string", "matchLevel": 2, "settings": { "weights": { "containsImage": 100, "isIdentityDocument": 100, "isPublishedOnline": 100, "firstName": 100, "lastName": 100, "expirationDate": 100, "dateOfBirth": 100, "matchesDateOfBirth": 100, "issueDate": 100, "hasMinimalAge": 100, "hasMatchingFaceProof": 100, "nationality": 100, "documentSubtype": 100, "isTampered": 100 }, "thresholds": { "rejectBelow": 100, "acceptAbove": 100 } } }'
KYC document updated.
ID of the KYC document.
"kyc_doc_0YV7JHY705C6DA487BFTAA33V8"
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'].
["file_0YV7HZ7KDCC5WBV9Q7WRKG1H6N"]
Document type submitted for validation. Only the identity-proof and address-proof types are analyzed automatically.
Document subtype submitted for validation.
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. |
ID of the KYC request.
"4f6cf35x-2c4y-483z-a0a9-158621f77a21"
Date and time which is set automatically when the resource is created.
Date and time which updates automatically when the resource is updated.
ID of the KYC document reviewer.
"44433322-2c4y-483z-a0a9-158621f77a21"
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.
Settings used to score the document.
Settings used to score the document.
{ "id": "kyc_doc_0YV7JHY705C6DA487BFTAA33V8", "fileIds": [ "file_0YV7HZ7KDCC5WBV9Q7WRKG1H6N" ], "documentType": "identity-proof", "documentSubtype": "passport", "status": "pending", "rejectionReason": { "type": "document-unreadable", "message": "Provided document is unreadable" }, "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": 2, "revision": 0, "documentMatches": { "score": 0.75, "data": { … } }, "parsedData": { "score": 0.75, "data": { … } }, "settings": { "weights": { … }, "thresholds": { … } }, "_links": [ { … } ], "_embedded": { "customer": {}, "files": [] } }
curl -i -X POST \ 'https://www.rebilly.com/_mock/docs/dev-docs/api/kyc-documents/{id}/acceptance' \ -H 'REB-APIKEY: YOUR_API_KEY_HERE'
KYC document acceptance created.
ID of the KYC document.
"kyc_doc_0YV7JHY705C6DA487BFTAA33V8"
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'].
["file_0YV7HZ7KDCC5WBV9Q7WRKG1H6N"]
Document type submitted for validation. Only the identity-proof and address-proof types are analyzed automatically.
Document subtype submitted for validation.
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. |
ID of the KYC request.
"4f6cf35x-2c4y-483z-a0a9-158621f77a21"
Date and time which is set automatically when the resource is created.
Date and time which updates automatically when the resource is updated.
ID of the KYC document reviewer.
"44433322-2c4y-483z-a0a9-158621f77a21"
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.
Settings used to score the document.
Settings used to score the document.
{ "id": "kyc_doc_0YV7JHY705C6DA487BFTAA33V8", "fileIds": [ "file_0YV7HZ7KDCC5WBV9Q7WRKG1H6N" ], "documentType": "identity-proof", "documentSubtype": "passport", "status": "pending", "rejectionReason": { "type": "document-unreadable", "message": "Provided document is unreadable" }, "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": 2, "revision": 0, "documentMatches": { "score": 0.75, "data": { … } }, "parsedData": { "score": 0.75, "data": { … } }, "settings": { "weights": { … }, "thresholds": { … } }, "_links": [ { … } ], "_embedded": { "customer": {}, "files": [] } }
Kyc document resource.
Matched identity data.
Specifies if an exact match of the document has been found online.
false
First name of the customer. This value is null if no match is found.
"John"
Last name of the customer. This value is null if no match is found.
"Doe"
Date of birth detected on the document. This value is null if no match is detected.
Expiration date detected on the document. This value is null if no expiration date is detected.
Issue date detected on the document. This value is null if no issue date is detected.
Nationality detected on a passport or citizenship document. This value is null if no nationality is detected.
"US"
Region, state, province, or territory that issued the document.
"Ontario"
Unique number on the identity document. This value may contain alphanumeric characters.
"1234567890"
Interpreted subtype of the uploaded document.
Specifies if an identity document has matching face proof.
false
curl -i -X POST \ 'https://www.rebilly.com/_mock/docs/dev-docs/api/kyc-documents/{id}/matches' \ -H 'Content-Type: application/json' \ -H 'REB-APIKEY: YOUR_API_KEY_HERE' \ -d '{ "containsImage": true, "isIdentityDocument": true, "isPublishedOnline": false, "firstName": "John", "lastName": "Doe", "dateOfBirth": "2019-08-24T14:15:22Z", "expirationDate": "2019-08-24T14:15:22Z", "issueDate": "2019-08-24T14:15:22Z", "nationality": "US", "issuanceCountry": "CA", "issuanceRegion": "Ontario", "documentNumber": "1234567890", "documentSubtype": "passport", "hasMatchingFaceProof": false, "isTampered": false, "expiryDate": "2019-08-24T14:15:22Z" }'
{ "status": 401, "type": "http://example.com", "title": "string", "detail": "string", "instance": "string" }
KYC document resource.
Reason the document is rejected.
curl -i -X POST \ 'https://www.rebilly.com/_mock/docs/dev-docs/api/kyc-documents/{id}/rejection' \ -H 'Content-Type: application/json' \ -H 'REB-APIKEY: YOUR_API_KEY_HERE' \ -d '{ "type": "document-unreadable", "message": "Provided document is unreadable" }'
KYC document rejected.
ID of the KYC document.
"kyc_doc_0YV7JHY705C6DA487BFTAA33V8"
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'].
["file_0YV7HZ7KDCC5WBV9Q7WRKG1H6N"]
Document type submitted for validation. Only the identity-proof and address-proof types are analyzed automatically.
Document subtype submitted for validation.
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. |
ID of the KYC request.
"4f6cf35x-2c4y-483z-a0a9-158621f77a21"
Date and time which is set automatically when the resource is created.
Date and time which updates automatically when the resource is updated.
ID of the KYC document reviewer.
"44433322-2c4y-483z-a0a9-158621f77a21"
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.
Settings used to score the document.
Settings used to score the document.
{ "id": "kyc_doc_0YV7JHY705C6DA487BFTAA33V8", "fileIds": [ "file_0YV7HZ7KDCC5WBV9Q7WRKG1H6N" ], "documentType": "identity-proof", "documentSubtype": "passport", "status": "pending", "rejectionReason": { "type": "document-unreadable", "message": "Provided document is unreadable" }, "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": 2, "revision": 0, "documentMatches": { "score": 0.75, "data": { … } }, "parsedData": { "score": 0.75, "data": { … } }, "settings": { "weights": { … }, "thresholds": { … } }, "_links": [ { … } ], "_embedded": { "customer": {}, "files": [] } }
curl -i -X POST \ 'https://www.rebilly.com/_mock/docs/dev-docs/api/kyc-documents/{id}/review' \ -H 'REB-APIKEY: YOUR_API_KEY_HERE'
KYC document reviewed.
ID of the KYC document.
"kyc_doc_0YV7JHY705C6DA487BFTAA33V8"
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'].
["file_0YV7HZ7KDCC5WBV9Q7WRKG1H6N"]
Document type submitted for validation. Only the identity-proof and address-proof types are analyzed automatically.
Document subtype submitted for validation.
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. |
ID of the KYC request.
"4f6cf35x-2c4y-483z-a0a9-158621f77a21"
Date and time which is set automatically when the resource is created.
Date and time which updates automatically when the resource is updated.
ID of the KYC document reviewer.
"44433322-2c4y-483z-a0a9-158621f77a21"
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.
Settings used to score the document.
Settings used to score the document.
{ "id": "kyc_doc_0YV7JHY705C6DA487BFTAA33V8", "fileIds": [ "file_0YV7HZ7KDCC5WBV9Q7WRKG1H6N" ], "documentType": "identity-proof", "documentSubtype": "passport", "status": "pending", "rejectionReason": { "type": "document-unreadable", "message": "Provided document is unreadable" }, "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": 2, "revision": 0, "documentMatches": { "score": 0.75, "data": { … } }, "parsedData": { "score": 0.75, "data": { … } }, "settings": { "weights": { … }, "thresholds": { … } }, "_links": [ { … } ], "_embedded": { "customer": {}, "files": [] } }
curl -i -X POST \ 'https://www.rebilly.com/_mock/docs/dev-docs/api/kyc-documents/{id}/start-review' \ -H 'REB-APIKEY: YOUR_API_KEY_HERE'
KYC document review started.
ID of the KYC document.
"kyc_doc_0YV7JHY705C6DA487BFTAA33V8"
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'].
["file_0YV7HZ7KDCC5WBV9Q7WRKG1H6N"]
Document type submitted for validation. Only the identity-proof and address-proof types are analyzed automatically.
Document subtype submitted for validation.
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. |
ID of the KYC request.
"4f6cf35x-2c4y-483z-a0a9-158621f77a21"
Date and time which is set automatically when the resource is created.
Date and time which updates automatically when the resource is updated.
ID of the KYC document reviewer.
"44433322-2c4y-483z-a0a9-158621f77a21"
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.
Settings used to score the document.
Settings used to score the document.
{ "id": "kyc_doc_0YV7JHY705C6DA487BFTAA33V8", "fileIds": [ "file_0YV7HZ7KDCC5WBV9Q7WRKG1H6N" ], "documentType": "identity-proof", "documentSubtype": "passport", "status": "pending", "rejectionReason": { "type": "document-unreadable", "message": "Provided document is unreadable" }, "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": 2, "revision": 0, "documentMatches": { "score": 0.75, "data": { … } }, "parsedData": { "score": 0.75, "data": { … } }, "settings": { "weights": { … }, "thresholds": { … } }, "_links": [ { … } ], "_embedded": { "customer": {}, "files": [] } }
curl -i -X POST \ 'https://www.rebilly.com/_mock/docs/dev-docs/api/kyc-documents/{id}/stop-review' \ -H 'REB-APIKEY: YOUR_API_KEY_HERE'
KYC document review stopped.
ID of the KYC document.
"kyc_doc_0YV7JHY705C6DA487BFTAA33V8"
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'].
["file_0YV7HZ7KDCC5WBV9Q7WRKG1H6N"]
Document type submitted for validation. Only the identity-proof and address-proof types are analyzed automatically.
Document subtype submitted for validation.
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. |
ID of the KYC request.
"4f6cf35x-2c4y-483z-a0a9-158621f77a21"
Date and time which is set automatically when the resource is created.
Date and time which updates automatically when the resource is updated.
ID of the KYC document reviewer.
"44433322-2c4y-483z-a0a9-158621f77a21"
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.
Settings used to score the document.
Settings used to score the document.
{ "id": "kyc_doc_0YV7JHY705C6DA487BFTAA33V8", "fileIds": [ "file_0YV7HZ7KDCC5WBV9Q7WRKG1H6N" ], "documentType": "identity-proof", "documentSubtype": "passport", "status": "pending", "rejectionReason": { "type": "document-unreadable", "message": "Provided document is unreadable" }, "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": 2, "revision": 0, "documentMatches": { "score": 0.75, "data": { … } }, "parsedData": { "score": 0.75, "data": { … } }, "settings": { "weights": { … }, "thresholds": { … } }, "_links": [ { … } ], "_embedded": { "customer": {}, "files": [] } }
curl -i -X GET \ https://www.rebilly.com/_mock/docs/dev-docs/api/kyc-settings \ -H 'REB-APIKEY: YOUR_API_KEY_HERE'
{ "identityProof": { "weights": { … }, "thresholds": { … } }, "addressProof": { "weights": { … }, "thresholds": { … } } }
curl -i -X PUT \ https://www.rebilly.com/_mock/docs/dev-docs/api/kyc-settings \ -H 'Content-Type: application/json' \ -H 'REB-APIKEY: YOUR_API_KEY_HERE' \ -d '{ "identityProof": { "weights": { "containsImage": 100, "isIdentityDocument": 100, "isPublishedOnline": 100, "firstName": 100, "lastName": 100, "expirationDate": 100, "dateOfBirth": 100, "matchesDateOfBirth": 100, "issueDate": 100, "hasMinimalAge": 100, "hasMatchingFaceProof": 100, "nationality": 100, "documentSubtype": 100, "isTampered": 100 }, "thresholds": { "rejectBelow": 100, "acceptAbove": 100 } }, "addressProof": { "weights": { "firstName": 100, "lastName": 100, "line1": 100, "city": 100, "region": 100, "postalCode": 100, "date": 100, "phone": 100, "documentSubtype": 100, "isTampered": 100 }, "thresholds": { "rejectBelow": 100, "acceptAbove": 100 } } }'
{ "identityProof": { "weights": { … }, "thresholds": { … } }, "addressProof": { "weights": { … }, "thresholds": { … } } }
KYC document webhook request body resource.
ID of the KYC document.
"kyc_doc_0YV7JHY705C6DA487BFTAA33V8"
Type of webhook event.
{ "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF", "kycDocumentId": "kyc_doc_0YV7JHY705C6DA487BFTAA33V8", "fileId": "file_0YV7HZ7KDCC5WBV9Q7WRKG1H6N", "eventType": "kyc-document-accepted", "_embedded": { "customer": { … }, "kycDocument": { … } }, "_links": [ { … } ] }
KYC document webhook request body resource.
ID of the KYC document.
"kyc_doc_0YV7JHY705C6DA487BFTAA33V8"
Type of webhook event.
{ "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF", "kycDocumentId": "kyc_doc_0YV7JHY705C6DA487BFTAA33V8", "fileId": "file_0YV7HZ7KDCC5WBV9Q7WRKG1H6N", "eventType": "kyc-document-accepted", "_embedded": { "customer": { … }, "kycDocument": { … } }, "_links": [ { … } ] }
KYC document webhook request body resource.
ID of the KYC document.
"kyc_doc_0YV7JHY705C6DA487BFTAA33V8"
Type of webhook event.
{ "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF", "kycDocumentId": "kyc_doc_0YV7JHY705C6DA487BFTAA33V8", "fileId": "file_0YV7HZ7KDCC5WBV9Q7WRKG1H6N", "eventType": "kyc-document-accepted", "_embedded": { "customer": { … }, "kycDocument": { … } }, "_links": [ { … } ] }
KYC document webhook request body resource.
ID of the KYC document.
"kyc_doc_0YV7JHY705C6DA487BFTAA33V8"
Type of webhook event.
{ "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF", "kycDocumentId": "kyc_doc_0YV7JHY705C6DA487BFTAA33V8", "fileId": "file_0YV7HZ7KDCC5WBV9Q7WRKG1H6N", "eventType": "kyc-document-accepted", "_embedded": { "customer": { … }, "kycDocument": { … } }, "_links": [ { … } ] }
KYC document webhook request body resource.
ID of the KYC document.
"kyc_doc_0YV7JHY705C6DA487BFTAA33V8"
Type of webhook event.
{ "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF", "kycDocumentId": "kyc_doc_0YV7JHY705C6DA487BFTAA33V8", "fileId": "file_0YV7HZ7KDCC5WBV9Q7WRKG1H6N", "eventType": "kyc-document-accepted", "_embedded": { "customer": { … }, "kycDocument": { … } }, "_links": [ { … } ] }
KYC request webhook body resource.
ID of the KYC request.
"kyc_req_0YV7JMJ3DBCGRBR7K9D4HVGPP5"
Rebilly webhooks event type.
{ "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF", "kycRequestId": "kyc_req_0YV7JMJ3DBCGRBR7K9D4HVGPP5", "eventType": "kyc-request-attempted", "_embedded": { "customer": { … }, "kycRequest": { … } }, "_links": [ { … } ] }
KYC request webhook body resource.
ID of the KYC request.
"kyc_req_0YV7JMJ3DBCGRBR7K9D4HVGPP5"
Rebilly webhooks event type.
{ "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF", "kycRequestId": "kyc_req_0YV7JMJ3DBCGRBR7K9D4HVGPP5", "eventType": "kyc-request-attempted", "_embedded": { "customer": { … }, "kycRequest": { … } }, "_links": [ { … } ] }
KYC request webhook body resource.
ID of the KYC request.
"kyc_req_0YV7JMJ3DBCGRBR7K9D4HVGPP5"
Rebilly webhooks event type.
{ "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF", "kycRequestId": "kyc_req_0YV7JMJ3DBCGRBR7K9D4HVGPP5", "eventType": "kyc-request-attempted", "_embedded": { "customer": { … }, "kycRequest": { … } }, "_links": [ { … } ] }
KYC request webhook body resource.
ID of the KYC request.
"kyc_req_0YV7JMJ3DBCGRBR7K9D4HVGPP5"
Rebilly webhooks event type.
{ "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF", "kycRequestId": "kyc_req_0YV7JMJ3DBCGRBR7K9D4HVGPP5", "eventType": "kyc-request-attempted", "_embedded": { "customer": { … }, "kycRequest": { … } }, "_links": [ { … } ] }
Use Anti-Money Laundering (AML) operations to screen customers and help prevent your business from becoming directly or indirectly involved in criminal activity.
Use AML operations during customer creation, and some transaction processing, to help determine if a potential customer (lead), or customer, has political or economic sanctions against them.
AML operations search the following for screening purposes: Politically Exposed Persons (PEPs) lists, sanction lists, and adverse media lists.
Use custom fields to extend a resource scheme to include custom data that is not provided as a common field. Depending on the resource on which the custom field is added, it may be available in the Rebilly UI.
Example: A custom field called preferredCommunicationChannel is added to the customer resource. It has two allowed values, which are 'email' and 'phone'.
{ "customFields": { "preferredCommunicationChannel": "email" } }
For detailed information on Rebilly resources, see Resources.
Use the file entity to store files and related metadata. Files can be sorted by size, MIME-type, user-defined tags, and description.
The following methods are available to upload files: multipart/form-data encoded form, RAW POST — by sending the file contents as the POST body, and fetching from URL — by providing the file URL using the 'url' parameter.
Use the attachments entity to link a file to one or multiple objects, such as: customer, dispute, transaction, order, plan, product, invoice, or timeline comment. Attachments enable you to quickly find and use files related to specific entities.