# KYC document archived

Endpoint: POST kyc-document-archived
Version: latest
Security: SecretApiKey, JWT

## Request fields (application/json):

  - `customerId` (string)
    ID of the customer resource.
    Example: "cus_0YV7DDSDD1C8DA64KHH2W33CPF"

  - `kycDocumentId` (string)
    ID of the KYC document.
    Example: "kyc_doc_0YV7JHY705C6DA487BFTAA33V8"

  - `fileId` (string)
    ID of the file.
    Example: "file_0YV7HZ7KDCC5WBV9Q7WRKG1H6N"

  - `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"

  - `_embedded` (object)
    Customer and KYC document data.

  - `_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 set as the  value.
If both are supplied, the value of this property overrides the  value.
The token expires after first use.

  - `_embedded.customer.defaultPaymentInstrument` (object,null)

  - `_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` (object,null)
    Customer's primary address.

  - `_embedded.customer.primaryAddress.firstName` (string,null)
    Contact's first name.
    Example: "Benjamin"

  - `_embedded.customer.primaryAddress.lastName` (string,null)
    Contact's last name.
    Example: "Franklin"

  - `_embedded.customer.primaryAddress.organization` (string,null)
    Contact's organization.
    Example: "Rebilly"

  - `_embedded.customer.primaryAddress.address` (string,null)
    First line of the contact's street address.
    Example: "36 Craven St"

  - `_embedded.customer.primaryAddress.address2` (string,null)
    Second line of the contact's street address.

  - `_embedded.customer.primaryAddress.city` (string,null)
    Contact's city of residence.
    Example: "Austin"

  - `_embedded.customer.primaryAddress.region` (string,null)
    Contact's region of residence.
    Example: "Texas"

  - `_embedded.customer.primaryAddress.country` (string,null)
    Contact's country of residence in ISO 3166 alpha-2 country code.
For examples, see [ISO.org](https://www.iso.org/obp/ui/#search/code/).
    Example: "GB"

  - `_embedded.customer.primaryAddress.postalCode` (string,null)
    Contact's postal code.
    Example: "WC2N 5NF"

  - `_embedded.customer.primaryAddress.phoneNumbers` (array)
    List of phone numbers associated with the contact.

  - `_embedded.customer.primaryAddress.phoneNumbers.label` (string, required)
    Phone number label or name.
    Example: "main"

  - `_embedded.customer.primaryAddress.phoneNumbers.value` (string, required)
    Phone number value.
    Example: "1-512-777-0269"

  - `_embedded.customer.primaryAddress.phoneNumbers.primary` (boolean)
    Specifies if the phone number is the contact's primary phone number.
    Example: true

  - `_embedded.customer.primaryAddress.emails` (array)
    List of email addresses associated with the contact.

  - `_embedded.customer.primaryAddress.emails.label` (string, required)
    Email label or name.
    Example: "main"

  - `_embedded.customer.primaryAddress.emails.value` (string, required)
    Email address value.
    Example: "rebilly@example.com"

  - `_embedded.customer.primaryAddress.emails.primary` (boolean)
    Specifies if the email address is the contact's primary email address.
    Example: true

  - `_embedded.customer.primaryAddress.dob` (string,null)
    Contact's date of birth in ISO-8601  format.
    Example: "1980-04-01"

  - `_embedded.customer.primaryAddress.jobTitle` (string,null)
    Contact's job title.
    Example: "CEO"

  - `_embedded.customer.isEddRequired` (boolean)
    Specifies if Enhanced Due Diligence (EDD) is enabled for this customer.
For more information, see [Enhanced Due Diligence](https://www.rebilly.com/docs/kyc-and-aml/edd/).

  - `_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 [ URL](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referer).

  - `_embedded.kycDocument` (object)
    KYC document information.

  - `_links` (array)
    Related links.

  - `_links.href` (string)
    Link URL.

  - `_links.rel` (string)
    Type of link.
    Enum: "customer", "file", "kycDocument"