- Introduction
- Authentication
- Errors
- SDKs
- Using filter with collections
- Expand to include embedded objects
- Getting started guide
- Customers
- getRetrieve a list of customers
- postCreate a customer (without an ID)
- getRetrieve a customer
- putUpsert a customer with predefined ID
- delMerge and delete a customer
- getRetrieve a customer's Lead Source
- putCreate a Lead Source for a customer
- delDelete a Lead Source for a customer
- getRetrieve a customer's EDD score data
- patchUpdate a customer's EDD score data
- getRetrieve a list of EDD timeline messages
- postCreate an EDD Timeline comment
- getRetrieve a customer's EDD search results
- EventCustomer created
- EventCustomer merged
- EventCustomer one-time-password requested
- EventCustomer updated
- EventExperian check performed
- Customer Authentication
- getRead current authentication options
- putChange authentication options
- getRetrieve a list of auth tokens
- postLogin a customer
- getVerify an authentication token
- delLogout a customer
- postExchange an authentication token
- getRetrieve a list of credentials
- postCreate a credential
- getRetrieve a credential
- putCreate or update a credential with predefined ID
- delDelete a credential
- getRetrieve a list of tokens
- postCreate a Reset Password Token
- getRetrieve a Reset Password Token
- delDelete a Reset Password Token
- Tags
- Customers Timeline
- getRetrieve a list of customer timeline custom event types
- postCreate Customer Timeline custom event type
- getRetrieve customer timeline custom event type
- getRetrieve a list of customer timeline messages
- postCreate a customer Timeline comment or custom defined event
- getRetrieve a customer Timeline message
- delDelete a Customer Timeline message
- Customers
- Transactions
- postReady to Pay
- postCreate a transaction
- getRetrieve a list of transactions
- getRetrieve a Transaction
- patchUpdate a transaction
- postCreate a credit transaction
- postQuery a Transaction
- postUpdate a Transaction status
- postRefund a Transaction
- EventCustomer redirected offsite
- EventCustomer returned
- EventGateway account requested
- EventNSF response received
- EventOffsite payment completed
- EventRisk score changed
- EventTransaction amount discrepancy found
- EventTransaction declined
- EventTransaction discrepancy found
- EventTransaction process requested
- EventTransaction processed
- EventTransaction timeout resolved
- EventWaiting gateway transaction completed
- Disputes
- Fees
- Transactions Timeline
- Transactions
- Orders
- getRetrieve a list of orders
- postCreate an order
- getRetrieve an order
- putUpsert an order with predefined ID
- delDelete a pending order
- postVoid an order
- postChange an order's items
- postIssue an interim invoice for a subscription order
- getRetrieve a list of subscription pauses
- postPause a subscription
- getRetrieve a subscription pause
- putUpdate a subscription pause
- delDelete a subscription pause
- getRetrieve a list of cancellations
- postCancel an order
- getRetrieve an order cancellation
- putCancel an order
- patchUpdate subscription cancellation
- delDelete a cancellation
- getRetrieve a list of reactivations
- postReactivate an order
- getRetrieve an order reactivation
- getRetrieve subscription order's upcoming invoice
- postIssue an upcoming invoice for early pay
- postPreview an order
- EventOrder completed
- EventRenewal invoice issued
- EventOrder activated
- EventSubscription order canceled
- EventSubscription downgraded
- EventOrder modified
- EventSubscription reactivated
- EventSubscription renewal reminder
- EventSubscription renewed
- EventSubscription trial converted
- EventSubscription trial end reminder
- EventSubscription trial ended
- EventSubscription trial end changed
- EventSubscription upgraded
- EventSubscription paused
- EventSubscription pause created
- EventSubscription pause modified
- EventSubscription pause revoked
- EventSubscription resumed
- Invoices
- getRetrieve a list of invoices
- postCreate an invoice
- getRetrieve an invoice
- putCreate or update an invoice with predefined ID
- getRetrieve invoice items
- postCreate an invoice item
- getGet an invoice item
- putUpdate an invoice item
- delDelete an invoice item
- postIssue an invoice
- postAbandon an invoice
- postVoid an invoice
- postRecalculate an invoice
- postReissue an invoice
- getGet transaction amounts allocated to an invoice
- postApply a transaction to an invoice
- getRetrieve customer's upcoming invoices
- getGet credit memo allocations to invoices
- getGet credit memo's amount allocated to the invoice
- putApply a credit memo to an invoice
- delDelete credit memo's allocation from the invoice
- EventInvoice tax calculation failed
- EventInvoice abandoned
- EventInvoice created
- EventInvoice issued
- EventInvoice modified
- EventInvoice paid
- EventInvoice partially paid
- EventInvoice refunded
- EventInvoice partially refunded
- EventInvoice past due
- EventInvoice past due reminder
- EventInvoice reissued
- EventInvoice voided
- EventRenewal invoice payment canceled
- EventRenewal invoice payment declined
- Credit memos
- Plans
- Products
- Coupons
- Shipping rates
- Orders Timeline
- Invoices Timeline
- Credit memos Timeline
- Orders
- Blocklists
- KYC Documents
- postCreate a KYC Request
- getRetrieve a list of KYC requests
- getRetrieve a KYC request
- patchUpdate a KYC request
- delDelete the KYC request
- getRetrieve a list of KYC documents
- postCreate a KYC Document
- getRetrieve a KYC Document
- putCreate or update a KYC document with predefined ID
- postAccept a KYC document
- postUpdate a KYC document's documentMatches
- postReject a KYC document
- postReview a KYC document
- postStart review for a KYC document
- postStop review for a KYC document
- getGet KYC settings
- putUpdate KYC settings
- EventKYC document accepted
- EventKYC document modified
- EventKYC document rejected
- EventKYC document reviewed
- EventKYC document archived
- EventKYC request attempted
- EventKYC request failed
- EventKYC request fulfilled
- EventKYC request partially fulfilled
- AML
Request KYC documents from customers using the KYC request API which generates a signed link to the KYC document gatherer. The types of documents to request:
- identity-proof
- address-proof
- purchase-proof
- funds-proof
- credit-file-proof
In the case that a credit-file-proof is requested in combination with identity-proof and address-proof, the credit-file-proof is attempted first. If it is successful in validating the identity and address, then the KYC request is considered instantly fulfilled. If it is not, or if you the credit-file-proof isn't requested, then redirect your customer to the KYC document gatherer to collect their KYC documents. Rebilly parses and analyzes the documents and accepts or rejects them according to a configurable scoring algorithm. When all of the document types in the KYC request are accepted, the status is considered fulfilled and the KYC request fulfilled webhook will be triggered. If a document is accepted while unreviewed documents of the same type exist, the unreviewed documents will be archived and the archived webhook will be triggered.