KYC document rejectedWebhook

SecuritySecretApiKey or JWT
Request
Request Body schema: application/json

KYC document webhook request body resource.

customerId
string (CustomerId) <= 50 characters

Customer resource ID.

kycDocumentId
string

ID of the KYC document.

fileId
string

ID of the file.

eventType
string

Type of webhook event.

Enum: "kyc-document-accepted" "kyc-document-created" "kyc-document-modified" "kyc-document-rejected" "kyc-document-reviewed" "kyc-document-archived"
object

Customer and KYC document data.

object (Customer)

Customer information.

id
string <= 50 characters

ID of the customer.

email
string or null <email>

Customer's email address.

firstName
string or null

Customer's first name.

lastName
string or null

Customer's last name.

websiteId
string <= 50 characters

ID of the website. A website is where an organization obtains a customer. For more information, see Obtain an organization ID and website ID.

(Vaulted instrument (object or null)) or (Alternative instrument (object or null)) or (Cash (object or null)) or (Check (object or null))

Default payment instrument information.

createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

customFields
object (ResourceCustomFields)
Default: {}

Use custom fields to extend a resource scheme to include custom data that is not provided as a common field. For more information, see Custom fields.

object or null

Customer's primary address.

object (CustomerAverageValue)

Average customer value.

paymentCount
integer

Total number of approved payments made by the customer.

lastPaymentTime
string or null <date-time>

Time and date of the customer's last approved payment.

object (CustomerLifetimeRevenue)

Customer's lifetime revenue.

invoiceCount
integer

Total number of invoices issued to the customer. This value is auto-incrementing. If this value is 0, the record relates to a lead. A lead is a customer who has not made a payment yet. If this value is greater than or equal to 1 the record relates to a customer.

Array of objects (Tag)

List of customer tags.

revision
integer

Number of times the customer's data has been modified.

Use this value when analyzing webhook data to determine if a change must take precedence over the current representation.

isEddRequired
boolean
Default: false

Specifies if Enhanced Due Diligence (EDD) is enabled for this customer. For more information, see Enhanced Due Diligence.

hasFulfilledKyc
boolean

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

organizationId
string <= 50 characters

Unique organization identifier. An organization is an entity that represents a company. For more information, see Obtain an organization ID.

Array of objects

Related links.

object

Embedded objects that are requested using the expand query string parameter.

object (KycDocument)

KYC document information.

customerId
required
string (CustomerId) <= 50 characters

Customer resource ID.

documentType
required
string

Document type submitted for validation. Only the identity-proof and address-proof types are analyzed automatically.

status
required
string

Status of the validation.

Enum: 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
string <= 50 characters

Unique resource ID. Defaults to UUID v4.

fileId
string <= 50 characters
Deprecated

ID of the linked file object.

fileIds
Array of strings

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

documentSubtype
string

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" … 16 more
object (KycDocumentRejection)

Reason the document is rejected.

requestId
string or null <= 50 characters

ID of the KYC request.

createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

processedTime
string <date-time>

Date and time when the KYC document is processed.

reviewerId
string or null <= 50 characters

ID of the KYC document reviewer.

reviewerName
string or null

First and last name of the KYC document reviewer.

reviewStartTime
string or null <date-time>

Date and time when the manual review starts.

reviewTime
string or null <date-time>

Date and time of manual review.

notes
string or null

Reviewer notes.

Array of objects (Tag)

List of KYC document tags.

reason
string

Reason for uploading.

matchLevel
integer [ 1 .. 2 ]

Tolerance level setting for document matches.

object or null

Settings used to score the document.

revision
integer

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.

object

Proof of identity document matches.

object

Parsed data.

Array of objects

Related links.

object

Embedded objects that are requested by the expand query parameter.

Array of objects

Related links.

Array
href
string

Link URL.

rel
string

Type of link.

Enum: "customer" "file" "kycDocument"
Responses
2xx

Returns any 2xx status to indicate that the data received.

Request samples
application/json
{
  • "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF",
  • "kycDocumentId": "string",
  • "fileId": "string",
  • "eventType": "kyc-document-accepted",
  • "_embedded": {
    },
  • "_links": [
    ]
}