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. Defaults to UUID v4.

kycDocumentId
string

The KYC document ID.

fileId
string

The file ID.

eventType
string (GlobalWebhookEventType)

Rebilly webhook event type.

Enum: "aml-list-possibly-matched" "application-instance-disabled" "application-instance-disabled" "application-instance-enabled" "application-instance-enabled" "balance-transaction-settled" "credit-memo-applied" "credit-memo-created" "credit-memo-modified" "credit-memo-partially-applied" … 76 more
object
object (Customer)
id
string <= 50 characters

Unique customer identifier string.

email
string <email>

Customer's email address.

firstName
string

Customer's first name.

lastName
string

Customer's last name.

websiteId
string <= 50 characters

ID of the website where the customer made a transaction. A website is where your organization obtains a customer. For more information, see My organizations and websites.

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

Date and time at which the was customer created.

updatedTime
string <date-time>

Read-only timestamp. This value updates 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 (ContactObject)
object (CustomerAverageValue)
paymentCount
integer

Total number of approved payments made by the customer.

lastPaymentTime
string <date-time>

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

object (CustomerLifetimeRevenue)
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)

A list of customer's 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 whether Enhanced Due Diligence (EDD) is enabled for this customer. For more information, see Enhanced Due Diligence.

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

Related resource links.

Array of LeadSourceEmbed (object) non-empty

Array of embedded objects that are requested using the expand query string parameter.

object (KycDocument)
customerId
required
string (CustomerId) <= 50 characters

Customer resource ID. Defaults to UUID v4.

documentType
required
string

Document type submitted for validation, only identity-proof type is analyzed in an automated manner.

status
required
string

Status of the validation.

Enum: Description
pending

Waiting to be reviewed or analyzed

in-progress

Being analyzed by Rebilly's AI

accepted

Accepted by AI or a human

rejected

Rejected by AI or a human

archived

Archived by Rebilly's AI

id
string <= 50 characters

Unique resource ID. Defaults to UUID v4.

fileId
string <= 50 characters
Deprecated

Linked file object id.

fileIds
Array of strings

Linked file object id's.

Files uploaded for identity-proof must have following corresponding tags attached ['kyc', 'id-front'], ['kyc', 'id-back'], ['kyc', 'face-proof'] in order to be properly recognized as identity-proof files.

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)
requestId
string or null <= 50 characters

KYC request identifier string.

createdTime
string <date-time>

Creation date/time.

updatedTime
string <date-time> (UpdatedTime)

Read-only timestamp. This value updates when the resource is updated.

processedTime
string <date-time>

Processing date/time.

reviewerId
string or null <= 50 characters

Reviewer's user ID.

reviewerName
string or null

Reviewer's first and last name.

reviewStartTime
string or null <date-time>

Date and time that 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)

A list of kyc document tags.

reason
string

Reason for uploading.

matchLevel
integer [ 1 .. 2 ]

The level of strictness for the document matches.

object or null

The settings used to score the document.

revision
integer

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

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

Related resource links.

Array of CustomerEmbed (object) non-empty

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

Array of CustomerLink (object) or FileLink (object) or KycDocumentLink (object) >= 3 items

Related resource links.

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

Type of link.

Enum: "customer" "targetCustomer"
href
required
string

Link URL.

Responses
2xx

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

Request samples
application/json
{
  • "customerId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "kycDocumentId": "string",
  • "fileId": "string",
  • "eventType": "aml-list-possibly-matched",
  • "_embedded": {
    },
  • "_links": [
    ]
}