# KYC request partially fulfilled

Endpoint: POST kyc-request-partially-fulfilled
Version: latest
Security: SecretApiKey, JWT

## Request fields

- `customerId` (string)
  ID of the customer resource.
  Example: cus_0YV7DDSDD1C8DA64KHH2W33CPF
- `kycRequestId` (string)
  ID of the KYC request.
  Example: kyc_req_0YV7JMJ3DBCGRBR7K9D4HVGPP5
- `eventType` (string)
  Type of event that triggered the webhook.
  Enum: "kyc-request-attempted", "kyc-request-failed", "kyc-request-fulfilled", "kyc-request-partially-fulfilled"
- `_embedded` (object)
  Embedded objects related to the KYC request event.
- `_embedded.customer` (object)
  Customer information.
- `_embedded.customer.websiteId` (string)
  ID of the website. A website is where an organization obtains a customer. For more information, see [Obtain an organization ID and website ID](https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id).
  Example: web_0YV7DE4Z26DQSA1AC92FBJ7SEG
- `_embedded.customer.paymentToken` (string)
  Write-only payment token. If supplied, the token is converted into a payment instrument, and its ID is assigned to `defaultPaymentInstrumentId` value. The value of this property overrides the `defaultPaymentInstrumentId` if both are supplied. This token may only be used once before it expires.
- `_embedded.customer.defaultPaymentInstrumentId` (string | null)
  ID of the customer's default payment instrument. The default payment instrument is used to automatically pay subscription renewals, and for transaction requests where a specific payment instrument is not provided.
  Example: inst_0YVB8KPKNXCBR9EDX7JHSED75N
- `_embedded.customer.preferredPayoutInstrumentId` (string | null)
  ID of the customer's preferred payment instrument for payouts.
  Example: inst_0YVB8KPKNXCBR9EDX7JHSED75N
- `_embedded.customer.customFields` (object)
  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](https://www.rebilly.com/catalog/all/custom-fields).
  Example: {"foo":"bar"}
- `_embedded.customer.primaryAddress` (any)
  Customer's primary address.
- `_embedded.customer.organizationId` (string)
  Unique organization identifier. An organization is an entity that represents a company. For more information, see [Obtain an organization ID](https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id).
  Example: org_0YVDM8RC7GDADADSBSMW124JA8
- `_embedded.customer.locale` (string | null)
  Language locale identifier in [RFC 5646](https://tools.ietf.org/html/rfc5646) format.
  Example: fr-FR
- `_embedded.customer.taxNumbers` (array | null)
  Tax numbers of the customer.
- `_embedded.customer.taxNumbers.type` (string, required)
  Type of the tax number.
  Enum: "eu-vat", "other"
- `_embedded.customer.taxNumbers.value` (string, required)
  Value of the tax number.
  Example: GB980780684
- `_embedded.customer.taxNumbers.isDefault` (boolean)
  Determines if the tax number is selected as default to display on invoices.
  Example: true
- `_embedded.customer.leadSource` (object)
  Lead source information.
- `_embedded.customer.leadSource.medium` (string | null)
  Category of the lead source traffic. For example, the medium could be organic search, Google ads, Display ads, and so on.
- `_embedded.customer.leadSource.source` (string | null)
  Domain, platform, or channel from which the lead source originates.
- `_embedded.customer.leadSource.campaign` (string | null)
  Campaign name of the lead source.
- `_embedded.customer.leadSource.term` (string | null)
  Term associated with a lead source.
- `_embedded.customer.leadSource.content` (string | null)
  Content contained in the lead source content. For example, content could be graphics, video, and so on.
- `_embedded.customer.leadSource.affiliate` (string | null)
  Individual or entity that is affiliated with the lead source.
- `_embedded.customer.leadSource.subAffiliate` (string | null)
  Individual or entity that is associated with a lead source affiliate. In other products, this field may also be referred to as sub ID or click ID in some.
- `_embedded.customer.leadSource.salesAgent` (string | null)
  Name of the sales agent associated with the lead source.
- `_embedded.customer.leadSource.clickId` (string | null)
  ID of the lead source click. This value is passed in the ad click URL for tracking and campaign attribution.
- `_embedded.customer.leadSource.path` (string | null)
  URL from which the lead source originates.
- `_embedded.customer.leadSource.referrer` (string | null)
  Lead source [`referrer` URL](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referer).
  Example: https://www.rebilly.com
- `_embedded.customer.personId` (string | null)
  ID of the associated person.
  Example: prs_0YV7DDSDD1C8DA64KHH2W33CPF
- `_embedded.customer.notificationEmails` (array)
  Email addresses for notification delivery in event-based email notifications. When you configure event-based email notifications, you can send to these addresses, the customer's primary email address, or another email address you specify. For more information, see [Manage notification emails](https://www.rebilly.com/docs/data-tables/manage-customer-information#manage-notification-emails).
- `_embedded.kycRequest` (object)
  KYC request information.
- `_embedded.kycRequest.documents` (array, required)
  Documents to request from the customer.
- `_embedded.kycRequest.documents.type` (string, required)
  Enum: "identity-proof", "address-proof", "funds-proof", "purchase-proof", "credit-file-proof"
- `_embedded.kycRequest.documents.subtypes` (array | null)
  Permitted document subtype.
- `_embedded.kycRequest.documents.maxAttempts` (integer)
  Total number of allowed document upload attempts. Use `0` to allow unlimited upload attempts.
- `_embedded.kycRequest.documents.faceProofRequired` (boolean)
  Specifies if the customer must upload a photo of their face (selfie) that matches a provided KYC document.
- `_embedded.kycRequest.documents.faceLivenessRequired` (boolean)
  Specifies if the customer must use the face liveness feature when uploading a selfie. For more information, see [Facial recognition and identity verification](https://www.rebilly.com/docs/kyc-and-aml/kyc#facial-recognition-identity-verification).
- `_embedded.kycRequest.redirectUrl` (string | null)
  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`.
- `_embedded.kycRequest.reason` (string | null)
  Reason for uploading.
  Example: spend limit
- `_embedded.kycRequest.matchLevel` (integer)
  Document verification level.
  Enum: 1, 2, 3
- `_embedded.kycRequest.expirationTime` (string)
  Date and time when the request expires. The default value is one hour in the future.
- `_links` (array)
  Links to related resources.
- `_links.href` (string)
  URL of the link.
- `_links.rel` (string)
  Relationship type of the link.
  Enum: "customer", "kycRequest"