KYC request partially fulfilledWebhook

SecuritySecretApiKey or JWT
Request
Request Body schema: application/json

KYC request webhook body resource.

customerId
string (CustomerId) <= 50 characters

The customer resource ID. Defaults to UUID v4.

kycRequestId
string

The KYC request ID.

eventType
string

Rebilly webhooks event type.

Enum: "kyc-request-attempted" "kyc-request-failed" "kyc-request-fulfilled" "kyc-request-partially-fulfilled"
object
object (Customer)
id
string <= 50 characters

The customer identifier string.

email
string <email>

The customer's email.

firstName
string

The customer's first name.

lastName
string

The customer's last name.

websiteId
string <= 50 characters

The website's ID.

Vaulted instrument (object) or Alternative Instrument (object) or Cash (object) or Check (object) (PaymentInstrumentValueObject)
createdTime
string <date-time>

The customer created time.

updatedTime
string <date-time>

Read-only timestamp updates when the resource is updated.

customFields
object (ResourceCustomFields)
Default: {}

Custom Fields list as a map {"custom field name": "custom field value", ...}. The format must follow the saved format (see Custom Fields section for the formats).

object (ContactObject)
object (CustomerAverageValue)
paymentCount
integer

The number of approved payments for the customer.

lastPaymentTime
string <date-time>

The most recent time of an approved payment for the customer.

object (CustomerLifetimeRevenue)
invoiceCount
integer

An auto-incrementing number based on the sequence of invoices. If set to 0, then this record is a Lead, otherwise is a Customer.

Array of objects (Tag)

A list of customer's tags.

revision
integer

The number of times the customer data has been modified. The revision is useful when analyzing webhook data to determine if the change takes precedence over the current representation.

isEddRequired
boolean
Default: false

Indicates if EDD is enabled for this customer.

hasFulfilledKyc
boolean

Specifies whether the customer has accepted and reviewed identity and address documents, or an accepted credit file document.

Array of Self (object) or DefaultPaymentInstrumentLink (object) or LeadSourceLink (object) or WebsiteLink (object) >= 3 items

The links related to resource.

Array of LeadSourceEmbed (object) non-empty

Any embedded objects available that are requested by the expand querystring parameter.

object (KycRequest)
required
Array of objects (KycRequestDocuments)

Documents to request from the customer.

customerId
required
string (CustomerId) <= 50 characters

The customer resource ID. Defaults to UUID v4.

id
string <= 50 characters

The resource ID. Defaults to UUID v4.

status
string

Status of the request.

Enum: Description
gathering

No documents have been provided yet. Temporary state.

attempted

At least one document has been provided but is not accepted. Temporary state.

partial

At least one requested document has the accepted status, but not all of them. Temporary state.

pending-review

At least one document type has a document with the pending status and no documents with the accepted status. Temporary state (until reviewed or another accepted document is provided).

fulfilled

All requested documents are provided and accepted. Permanent state.

failed

At least one requested document exhausted all attempts and does not have the status accepted, pending or in-progress. Permanent state.

abandoned

Request expired and has at least one document provided. Permanent state.

expired

Request expired without any document uploaded. Permanent state.

redirectUrl
string <uri>

The URL to redirect the customer when an upload is completed. When the customer is redirected, Rebilly will append an info query parameter which may have one of the following values (example: https://example.com?info=success):

  • back - The customer clicked the back to website link;
  • token_expired - The customer's token expired;
  • success - The customer uploaded docs that were successfully analyzed;
  • manual - The customer uploaded docs that will require manual review because the analyzer rejected them or couldn't process them;
  • partial - The customer had success with some doc type but not with other (for example, successful proof of address but skipped proof of id).
expirationTime
string <date-time>

Expiration date-time. Default value is one hour in the future.

createdTime
string <date-time>

Creation date-time.

updatedTime
string <date-time> (UpdatedTime)

Read-only timestamp updates when the resource is updated.

reason
string

Reason for uploading.

matchLevel
integer [ 1 .. 2 ]
Default: 2

The level of strictness for the document matches. The value of 1 is less strict and 2 is strict.

revision
integer

The number of times the KYC request data has been modified. The revision is useful when analyzing webhook data to determine if the change takes precedence over the current representation.

Array of Self (object) or KycDocumentsLink (object) or KycGathererLink (object) non-empty

The links related to the resource.

object

Any embedded objects available that are requested by the expand querystring parameter.

Array of CustomerLink (object) or KycRequestLink (object) >= 2 items

The links related to resource.

Array (>= 2 items)
Any of:
rel
required
string

The link type.

Enum: "customer" "targetCustomer"
href
required
string

The link URL.

Responses
2xx

Return any 2xx status to indicate that the data was received successfully.

Request samples
application/json
{
  • "customerId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "kycRequestId": "string",
  • "eventType": "kyc-request-attempted",
  • "_embedded": {
    },
  • "_links": [
    ]
}