---
title: "Update an entity"
method: PATCH
path: "/v0/entities/{id}"
tags: ["Entity"]
---

# Update an entity

`PATCH /v0/entities/{id}`

Certain updates on Entity trigger KYC re-screening, requiring an updated kyc_details.result and kyc_details.screened_at.

For individual entities, KYC re-screening is triggered by changes to: first name, last name, date of birth, tax ID (for US entities), existing identification document (for non-US entities), and switching between US vs. non-US entities.

For business and sole proprietorship entities, KYC re-screening is triggered by changes to: business name, business type, tax ID (US entities), and existing identification document (non-US entities).

Note: Business and sole proprietors cannot switch between US and non-US entities. A new entity must be created in such case.

## Path parameters

- `id` string, required

## Headers

- `Idempotency-Key` string, required

## Request body

- union
  - UpdateAnIndividualEntityRequestBody
    - `type` string, required — Type of entity = individual.
    - `intended_roles` IntendedRolesEnum[]
    - `risk_score` 'low' | 'medium' | 'high' — The entity's risk score, mapped to Lead by the client. Client should have provided risk score mapping to Lead.
    - `individual_details` UpdateIndividualDetails — Details for the individual entity
      - `first_name` string — Legal first name. Must be at least 2 character.
      - `preferred_first_name` string — Preferred first name.
      - `middle_name` string — Middle name.
      - `last_name` string — Legal last name. Must be at least 2 character.
      - `date_of_birth` string, date — Date of birth, in YYYY-MM-DD format. Authorized signers and account holders must be 18 years or older.
      - `occupation` string — Occupation / job.
      - `contact_methods` ContactMethod[]
        - union
          - object
            - `type` string, required — ContactMethodType = email.
            - `email` string, required — Must be a valid email address in the form `local-part@domain.tld`. The domain must contain at least one dot. Addresses using `localhost`, IP literals (e.g., user@[127.0.0.1]), or quoted local parts (e.g., "user"@example.com) are not accepted. Only common, real-world email formats are supported.
          - object
            - `type` string, required — ContactMethodType = phone_number. Conforms to E.123 standard
            - `phone_number` string, required — Primary phone number of the entity. Must follow E.123 format.
      - `address_details` UpdateAddressDetails
        - `physical_address` UpdateAddress
          - `line_1` string — Address line 1 is the required primary street-address field. It must contain the full base address needed to identify the physical location, such as the street number and street name together, or the closest local equivalent in countries where addresses do not use that exact structure. Use address line 1 for all core location details that describe the main property or thoroughfare. Regardless of how each component of an address is collected from your end-users, they must be combined into address line 1 before sending to Lead. Do not: - split the primary street address across line 1 and line 2 - put only the street number in line 1 and the street name in line 2 - pad line 1 with false or altered data just to satisfy validation
          - `line_2` string — Address line 2 is optional and should be used only for secondary or sub-premise information, such as: - apartment - unit - suite - floor - building - care-of / attention If there is no secondary or sub-premise information, address line 2 should be blank. Do not use address line 2 for any part of the primary street address.
          - `city` string — City.
          - `postal_code` string — Postal Code, required for US addresses. Please follow the following format: US: ^\d5(?:-\d4)?$, CN: ^\d6$, GB: ^[A-Z]{1,2}d[A-Z0-9]? ?d[A-Z]{2}$, JP: ^\d3-\d4$
          - `state` string — State. required for US addresses in 2 character code (e.g. NY).
          - `country` string — ISO3166-1 Alpha-2 country code.
        - `mailing_address` UpdateAddress
          - `line_1` string — Address line 1 is the required primary street-address field. It must contain the full base address needed to identify the physical location, such as the street number and street name together, or the closest local equivalent in countries where addresses do not use that exact structure. Use address line 1 for all core location details that describe the main property or thoroughfare. Regardless of how each component of an address is collected from your end-users, they must be combined into address line 1 before sending to Lead. Do not: - split the primary street address across line 1 and line 2 - put only the street number in line 1 and the street name in line 2 - pad line 1 with false or altered data just to satisfy validation
          - `line_2` string — Address line 2 is optional and should be used only for secondary or sub-premise information, such as: - apartment - unit - suite - floor - building - care-of / attention If there is no secondary or sub-premise information, address line 2 should be blank. Do not use address line 2 for any part of the primary street address.
          - `city` string — City.
          - `postal_code` string — Postal Code, required for US addresses. Please follow the following format: US: ^\d5(?:-\d4)?$, CN: ^\d6$, GB: ^[A-Z]{1,2}d[A-Z0-9]? ?d[A-Z]{2}$, JP: ^\d3-\d4$
          - `state` string — State. required for US addresses in 2 character code (e.g. NY).
          - `country` string — ISO3166-1 Alpha-2 country code.
        - `other_addresses` Address[] — Other addresses for the entity.
          - `line_1` string, required — Address line 1 is the required primary street-address field. It must contain the full base address needed to identify the physical location, such as the street number and street name together, or the closest local equivalent in countries where addresses do not use that exact structure. Use address line 1 for all core location details that describe the main property or thoroughfare. Regardless of how each component of an address is collected from your end-users, they must be combined into address line 1 before sending to Lead. Do not: - split the primary street address across line 1 and line 2 - put only the street number in line 1 and the street name in line 2 - pad line 1 with false or altered data just to satisfy validation
          - `line_2` string — Address line 2 is optional and should be used only for secondary or sub-premise information, such as: - apartment - unit - suite - floor - building - care-of / attention If there is no secondary or sub-premise information, address line 2 should be blank. Do not use address line 2 for any part of the primary street address.
          - `city` string, required — City.
          - `postal_code` string — Postal Code, required for US addresses. Please follow the following format: US: ^\d5(?:-\d4)?$, CN: ^\d6$, GB: ^[A-Z]{1,2}d[A-Z0-9]? ?d[A-Z]{2}$, JP: ^\d3-\d4$
          - `state` string — State. required for US addresses in 2 character code (e.g. NY).
          - `country` string, required — ISO3166-1 Alpha-2 country code.
      - `identification_details` union
        - object
          - `type` string, required — Entity is considered US entity if they have US tax identification. For US entities, US tax identification number as well as other available government-verified identification documents, if collected, are required.
          - `tax_identification` TaxIdentification
            - `type` 'ssn' | 'itin' | 'ein', required — The entity's US tax identification type. - For `individual` entity, `ssn` or `itin` is required. - For `business` entity, `ein` is required. For single-member LLC entities where no EIN is available, `ssn` or `itin` may be used. - For `sole_prop` entity, `ssn` or `itin` or `ein` is required.
            - `value` string, required — The entity's US tax identification number. Must be 9 digits (e.g. XXXXXXXXX). ssn must not start with a 9. ein must begin with a number between 00 and 99. itin must begin with a 9
          - `identification_documents` IdentificationDocument[]
            - `client_document_id` string — Client document ID for the identification document.
            - `type` 'drivers_license' | 'state_or_provincial_id' | 'passport' | 'permanent_residency_id' | 'military_id' | 'national_id' | 'matriculate_id' | 'other' | 'tax_certificate' | 'tax_returns' | 'partnership_agreement' | 'certificate_of_good_standing' | 'formation_document' | 'proof_of_place_on_stock_exchange' | 'name_certificate', required — The entity's government-verified identification document type. This will apply for identification types other than US tax identification. - For `individual` entity, possible types are: `drivers_license`, `state_or_provincial_id`, `passport`, `permanent_residency_id`, `military_id`, `national_id`, `matriculate_id`, `other`. Note that `national_id` and `matriculate_id` are not applicable for `us_entity`. - For `business` entity, possible types are: `tax_certificate`, `tax_returns`, `partnership_agreement`, `certificate_of_good_standing`, `formation_document`, `proof_of_place_on_stock_exchange`, `other`. - For `sole_prop` entity, possible types are: `tax_certificate`, `tax_returns`, `name_certificate`, `drivers_license`, `state_or_provincial_id`, `passport`, `permanent_residency_id`, `military_id`, `national_id`, `matriculate_id`, `other`. Note that `national_id` and `matriculate_id` are not applicable for `us_entity`.
            - `description` string — Description about the identification document. Required if identification document type is `other`.
            - `identification_number` string, required — Unique identification number on the identification document.
            - `expiration_date` string, date — Expiration date of the identification document.
            - `issuing_state` string — Issuing state of the identification document. Must be 2 character code (e.g. NY). If the issuing country is US, this value must be a valid US State.
            - `issuing_country` string, required — Issuing country of the identification document. ISO3166-1 Alpha-2 country code.
        - object
          - `type` string, required — Entity is considered non-US entity if they do not have US tax identification. For non-US entities, at least 1 government-verified identification documents is required.
          - `identification_documents` IdentificationDocument[]
            - `client_document_id` string — Client document ID for the identification document.
            - `type` 'drivers_license' | 'state_or_provincial_id' | 'passport' | 'permanent_residency_id' | 'military_id' | 'national_id' | 'matriculate_id' | 'other' | 'tax_certificate' | 'tax_returns' | 'partnership_agreement' | 'certificate_of_good_standing' | 'formation_document' | 'proof_of_place_on_stock_exchange' | 'name_certificate', required — The entity's government-verified identification document type. This will apply for identification types other than US tax identification. - For `individual` entity, possible types are: `drivers_license`, `state_or_provincial_id`, `passport`, `permanent_residency_id`, `military_id`, `national_id`, `matriculate_id`, `other`. Note that `national_id` and `matriculate_id` are not applicable for `us_entity`. - For `business` entity, possible types are: `tax_certificate`, `tax_returns`, `partnership_agreement`, `certificate_of_good_standing`, `formation_document`, `proof_of_place_on_stock_exchange`, `other`. - For `sole_prop` entity, possible types are: `tax_certificate`, `tax_returns`, `name_certificate`, `drivers_license`, `state_or_provincial_id`, `passport`, `permanent_residency_id`, `military_id`, `national_id`, `matriculate_id`, `other`. Note that `national_id` and `matriculate_id` are not applicable for `us_entity`.
            - `description` string — Description about the identification document. Required if identification document type is `other`.
            - `identification_number` string, required — Unique identification number on the identification document.
            - `expiration_date` string, date — Expiration date of the identification document.
            - `issuing_state` string — Issuing state of the identification document. Must be 2 character code (e.g. NY). If the issuing country is US, this value must be a valid US State.
            - `issuing_country` string, required — Issuing country of the identification document. ISO3166-1 Alpha-2 country code.
      - `additional_documents` AdditionalDocument[]
        - `client_document_id` string — Client document ID for the additional document.
        - `type` 'bank_statement' | 'utility_bills' | 'proof_of_address' | 'investigation_report' | 'financial_statement' | 'public_records' | 'adverse_media' | 'id_selfie' | 'other', required — Type of additional non-government documents being provided to verify entity. Possible values are `bank_statement`, `utility_bills`, `proof_of_address`, `investigation_report`, `financial_statement`, `public_records`, `adverse_media`, `id_selfie`, `other`.
        - `description` string — Description about the identification document. Required if additional document type is `other`.
    - `rfi_details` RfiDetails
      - `result` 'requested' | 'completed', required — Result of request for information with the end customer. Leave blank if RFI has not been sent to the customer.
      - `requested_at` string, date-time, required — Date time RFI is requested at.
    - `ofac_details` OfacDetails — Details on OFAC on the entity.
      - `result` 'pending' | 'passed' | 'failed', required — OFAC result. Possible values: pending | passed | failed.
      - `screened_at` string, date-time, required — Date time OFAC screen is screened at.
    - `kyc_details` KycDetails — Details on KYC on the entity.
      - `result` 'pending' | 'passed' | 'failed', required — KYC result. Possible values: pending | passed | failed.
      - `screened_at` string, date-time, required — Date time KYC screen is screened at.
    - `credit_details` CreditDetails[]
      - `credit_score` string — Credit score given by the credit bureau. Cannot be above 850. Mutually exclusive with `credit_report_non_score_value`.
      - `credit_report_non_score_value` 'unestablished' | 'frozen' — Indicates the state of a credit file when a numeric score is not available.
      - `credit_report_source` 'equifax' | 'experian' | 'transunion', required — The name of the credit bureau.
      - `credit_pulled_at` string, date-time, required — Date time credit is pulled at.
    - `metadata` Metadata — A set of key-value pairs that can be used to store additional information related to this object.
  - UpdateABusinessEntityRequestBody
    - `type` string, required — Type of entity = business.
    - `intended_roles` IntendedRolesEnum[]
    - `risk_score` 'low' | 'medium' | 'high' — The entity's risk score, mapped to Lead by the client. Client should have provided risk score mapping to Lead.
    - `business_details` UpdateBusinessDetails — Details for the business entity
      - `type` 'corporation' | 'partnership' | 'sole_prop' | 'llc' | 'trust' | 'cooperative' | 'other' — Business Types. Possible business types are `corporation`, `partnership`, `sole_prop`, `llc`, `trust`, `cooperative`, `other`. - For business entity, cannot use `sole_prop` as business type. - For sole_prop entity, must use `sole_prop` as business type.
      - `name` string — Legal name of the business. Must be at least 2 characters.
      - `gross_annual_revenue` string — Business gross revenue for prior fiscal year.
      - `currency_code` string — A three-letter currency code as defined in ISO 4217.
      - `industry` string[] — NAICS code(s) for the applicable industries. 2-6 digits of NAICS code(s) are accepted and valid NAICS codes can be found on naics.com.
      - `doing_business_as` string — Business name if the business operates under a different name.
      - `website` string — The website of the business. Must start with http:// or https://.
      - `contact_methods` ContactMethod[]
        - union
          - object
            - `type` string, required — ContactMethodType = email.
            - `email` string, required — Must be a valid email address in the form `local-part@domain.tld`. The domain must contain at least one dot. Addresses using `localhost`, IP literals (e.g., user@[127.0.0.1]), or quoted local parts (e.g., "user"@example.com) are not accepted. Only common, real-world email formats are supported.
          - object
            - `type` string, required — ContactMethodType = phone_number. Conforms to E.123 standard
            - `phone_number` string, required — Primary phone number of the entity. Must follow E.123 format.
      - `address_details` UpdateAddressDetails
        - `physical_address` UpdateAddress
          - `line_1` string — Address line 1 is the required primary street-address field. It must contain the full base address needed to identify the physical location, such as the street number and street name together, or the closest local equivalent in countries where addresses do not use that exact structure. Use address line 1 for all core location details that describe the main property or thoroughfare. Regardless of how each component of an address is collected from your end-users, they must be combined into address line 1 before sending to Lead. Do not: - split the primary street address across line 1 and line 2 - put only the street number in line 1 and the street name in line 2 - pad line 1 with false or altered data just to satisfy validation
          - `line_2` string — Address line 2 is optional and should be used only for secondary or sub-premise information, such as: - apartment - unit - suite - floor - building - care-of / attention If there is no secondary or sub-premise information, address line 2 should be blank. Do not use address line 2 for any part of the primary street address.
          - `city` string — City.
          - `postal_code` string — Postal Code, required for US addresses. Please follow the following format: US: ^\d5(?:-\d4)?$, CN: ^\d6$, GB: ^[A-Z]{1,2}d[A-Z0-9]? ?d[A-Z]{2}$, JP: ^\d3-\d4$
          - `state` string — State. required for US addresses in 2 character code (e.g. NY).
          - `country` string — ISO3166-1 Alpha-2 country code.
        - `mailing_address` UpdateAddress
          - `line_1` string — Address line 1 is the required primary street-address field. It must contain the full base address needed to identify the physical location, such as the street number and street name together, or the closest local equivalent in countries where addresses do not use that exact structure. Use address line 1 for all core location details that describe the main property or thoroughfare. Regardless of how each component of an address is collected from your end-users, they must be combined into address line 1 before sending to Lead. Do not: - split the primary street address across line 1 and line 2 - put only the street number in line 1 and the street name in line 2 - pad line 1 with false or altered data just to satisfy validation
          - `line_2` string — Address line 2 is optional and should be used only for secondary or sub-premise information, such as: - apartment - unit - suite - floor - building - care-of / attention If there is no secondary or sub-premise information, address line 2 should be blank. Do not use address line 2 for any part of the primary street address.
          - `city` string — City.
          - `postal_code` string — Postal Code, required for US addresses. Please follow the following format: US: ^\d5(?:-\d4)?$, CN: ^\d6$, GB: ^[A-Z]{1,2}d[A-Z0-9]? ?d[A-Z]{2}$, JP: ^\d3-\d4$
          - `state` string — State. required for US addresses in 2 character code (e.g. NY).
          - `country` string — ISO3166-1 Alpha-2 country code.
        - `other_addresses` Address[] — Other addresses for the entity.
          - `line_1` string, required — Address line 1 is the required primary street-address field. It must contain the full base address needed to identify the physical location, such as the street number and street name together, or the closest local equivalent in countries where addresses do not use that exact structure. Use address line 1 for all core location details that describe the main property or thoroughfare. Regardless of how each component of an address is collected from your end-users, they must be combined into address line 1 before sending to Lead. Do not: - split the primary street address across line 1 and line 2 - put only the street number in line 1 and the street name in line 2 - pad line 1 with false or altered data just to satisfy validation
          - `line_2` string — Address line 2 is optional and should be used only for secondary or sub-premise information, such as: - apartment - unit - suite - floor - building - care-of / attention If there is no secondary or sub-premise information, address line 2 should be blank. Do not use address line 2 for any part of the primary street address.
          - `city` string, required — City.
          - `postal_code` string — Postal Code, required for US addresses. Please follow the following format: US: ^\d5(?:-\d4)?$, CN: ^\d6$, GB: ^[A-Z]{1,2}d[A-Z0-9]? ?d[A-Z]{2}$, JP: ^\d3-\d4$
          - `state` string — State. required for US addresses in 2 character code (e.g. NY).
          - `country` string, required — ISO3166-1 Alpha-2 country code.
      - `identification_details` union
        - object
          - `type` string, required — Entity is considered US entity if they have US tax identification. For US entities, US tax identification number as well as other available government-verified identification documents, if collected, are required.
          - `tax_identification` TaxIdentification
            - `type` 'ssn' | 'itin' | 'ein', required — The entity's US tax identification type. - For `individual` entity, `ssn` or `itin` is required. - For `business` entity, `ein` is required. For single-member LLC entities where no EIN is available, `ssn` or `itin` may be used. - For `sole_prop` entity, `ssn` or `itin` or `ein` is required.
            - `value` string, required — The entity's US tax identification number. Must be 9 digits (e.g. XXXXXXXXX). ssn must not start with a 9. ein must begin with a number between 00 and 99. itin must begin with a 9
          - `identification_documents` IdentificationDocument[]
            - `client_document_id` string — Client document ID for the identification document.
            - `type` 'drivers_license' | 'state_or_provincial_id' | 'passport' | 'permanent_residency_id' | 'military_id' | 'national_id' | 'matriculate_id' | 'other' | 'tax_certificate' | 'tax_returns' | 'partnership_agreement' | 'certificate_of_good_standing' | 'formation_document' | 'proof_of_place_on_stock_exchange' | 'name_certificate', required — The entity's government-verified identification document type. This will apply for identification types other than US tax identification. - For `individual` entity, possible types are: `drivers_license`, `state_or_provincial_id`, `passport`, `permanent_residency_id`, `military_id`, `national_id`, `matriculate_id`, `other`. Note that `national_id` and `matriculate_id` are not applicable for `us_entity`. - For `business` entity, possible types are: `tax_certificate`, `tax_returns`, `partnership_agreement`, `certificate_of_good_standing`, `formation_document`, `proof_of_place_on_stock_exchange`, `other`. - For `sole_prop` entity, possible types are: `tax_certificate`, `tax_returns`, `name_certificate`, `drivers_license`, `state_or_provincial_id`, `passport`, `permanent_residency_id`, `military_id`, `national_id`, `matriculate_id`, `other`. Note that `national_id` and `matriculate_id` are not applicable for `us_entity`.
            - `description` string — Description about the identification document. Required if identification document type is `other`.
            - `identification_number` string, required — Unique identification number on the identification document.
            - `expiration_date` string, date — Expiration date of the identification document.
            - `issuing_state` string — Issuing state of the identification document. Must be 2 character code (e.g. NY). If the issuing country is US, this value must be a valid US State.
            - `issuing_country` string, required — Issuing country of the identification document. ISO3166-1 Alpha-2 country code.
        - object
          - `type` string, required — Entity is considered non-US entity if they do not have US tax identification. For non-US entities, at least 1 government-verified identification documents is required.
          - `identification_documents` IdentificationDocument[]
            - `client_document_id` string — Client document ID for the identification document.
            - `type` 'drivers_license' | 'state_or_provincial_id' | 'passport' | 'permanent_residency_id' | 'military_id' | 'national_id' | 'matriculate_id' | 'other' | 'tax_certificate' | 'tax_returns' | 'partnership_agreement' | 'certificate_of_good_standing' | 'formation_document' | 'proof_of_place_on_stock_exchange' | 'name_certificate', required — The entity's government-verified identification document type. This will apply for identification types other than US tax identification. - For `individual` entity, possible types are: `drivers_license`, `state_or_provincial_id`, `passport`, `permanent_residency_id`, `military_id`, `national_id`, `matriculate_id`, `other`. Note that `national_id` and `matriculate_id` are not applicable for `us_entity`. - For `business` entity, possible types are: `tax_certificate`, `tax_returns`, `partnership_agreement`, `certificate_of_good_standing`, `formation_document`, `proof_of_place_on_stock_exchange`, `other`. - For `sole_prop` entity, possible types are: `tax_certificate`, `tax_returns`, `name_certificate`, `drivers_license`, `state_or_provincial_id`, `passport`, `permanent_residency_id`, `military_id`, `national_id`, `matriculate_id`, `other`. Note that `national_id` and `matriculate_id` are not applicable for `us_entity`.
            - `description` string — Description about the identification document. Required if identification document type is `other`.
            - `identification_number` string, required — Unique identification number on the identification document.
            - `expiration_date` string, date — Expiration date of the identification document.
            - `issuing_state` string — Issuing state of the identification document. Must be 2 character code (e.g. NY). If the issuing country is US, this value must be a valid US State.
            - `issuing_country` string, required — Issuing country of the identification document. ISO3166-1 Alpha-2 country code.
      - `additional_documents` AdditionalDocument[]
        - `client_document_id` string — Client document ID for the additional document.
        - `type` 'bank_statement' | 'utility_bills' | 'proof_of_address' | 'investigation_report' | 'financial_statement' | 'public_records' | 'adverse_media' | 'id_selfie' | 'other', required — Type of additional non-government documents being provided to verify entity. Possible values are `bank_statement`, `utility_bills`, `proof_of_address`, `investigation_report`, `financial_statement`, `public_records`, `adverse_media`, `id_selfie`, `other`.
        - `description` string — Description about the identification document. Required if additional document type is `other`.
    - `beneficial_owners` BeneficialOwners[]
      - `entity_id` string, required — Individual entity_id created for the beneficial owner. Data requirements for beneficial owners match those of authorized_signer roles.
      - `ownership_percentage` string — Percentage ownership (0-100.00 or 0-1.00 for decimal representation).
      - `relationship_established_at` string, date — The date the relationship was established.
    - `control_persons` ControlPersons[]
      - `entity_id` string, required — Individual entity_id created for the control person. Data requirements for control persons match those of authorized_signer roles.
      - `title` string, required — The title of this control person.
      - `relationship_established_at` string, date — The date the relationship was established.
    - `rfi_details` RfiDetails
      - `result` 'requested' | 'completed', required — Result of request for information with the end customer. Leave blank if RFI has not been sent to the customer.
      - `requested_at` string, date-time, required — Date time RFI is requested at.
    - `ofac_details` OfacDetails — Details on OFAC on the entity.
      - `result` 'pending' | 'passed' | 'failed', required — OFAC result. Possible values: pending | passed | failed.
      - `screened_at` string, date-time, required — Date time OFAC screen is screened at.
    - `kyc_details` KycDetails — Details on KYC on the entity.
      - `result` 'pending' | 'passed' | 'failed', required — KYC result. Possible values: pending | passed | failed.
      - `screened_at` string, date-time, required — Date time KYC screen is screened at.
    - `credit_details` CreditDetails[]
      - `credit_score` string — Credit score given by the credit bureau. Cannot be above 850. Mutually exclusive with `credit_report_non_score_value`.
      - `credit_report_non_score_value` 'unestablished' | 'frozen' — Indicates the state of a credit file when a numeric score is not available.
      - `credit_report_source` 'equifax' | 'experian' | 'transunion', required — The name of the credit bureau.
      - `credit_pulled_at` string, date-time, required — Date time credit is pulled at.
    - `metadata` Metadata — A set of key-value pairs that can be used to store additional information related to this object.
  - UpdateASolePropEntityRequestBody
    - `type` string, required — Type of entity = sole_prop.
    - `intended_roles` IntendedRolesEnum[]
    - `risk_score` 'low' | 'medium' | 'high' — The entity's risk score, mapped to Lead by the client. Client should have provided risk score mapping to Lead.
    - `business_details` UpdateBusinessDetails — Details for the business entity
      - `type` 'corporation' | 'partnership' | 'sole_prop' | 'llc' | 'trust' | 'cooperative' | 'other' — Business Types. Possible business types are `corporation`, `partnership`, `sole_prop`, `llc`, `trust`, `cooperative`, `other`. - For business entity, cannot use `sole_prop` as business type. - For sole_prop entity, must use `sole_prop` as business type.
      - `name` string — Legal name of the business. Must be at least 2 characters.
      - `gross_annual_revenue` string — Business gross revenue for prior fiscal year.
      - `currency_code` string — A three-letter currency code as defined in ISO 4217.
      - `industry` string[] — NAICS code(s) for the applicable industries. 2-6 digits of NAICS code(s) are accepted and valid NAICS codes can be found on naics.com.
      - `doing_business_as` string — Business name if the business operates under a different name.
      - `website` string — The website of the business. Must start with http:// or https://.
      - `contact_methods` ContactMethod[]
        - union
          - object
            - `type` string, required — ContactMethodType = email.
            - `email` string, required — Must be a valid email address in the form `local-part@domain.tld`. The domain must contain at least one dot. Addresses using `localhost`, IP literals (e.g., user@[127.0.0.1]), or quoted local parts (e.g., "user"@example.com) are not accepted. Only common, real-world email formats are supported.
          - object
            - `type` string, required — ContactMethodType = phone_number. Conforms to E.123 standard
            - `phone_number` string, required — Primary phone number of the entity. Must follow E.123 format.
      - `address_details` UpdateAddressDetails
        - `physical_address` UpdateAddress
          - `line_1` string — Address line 1 is the required primary street-address field. It must contain the full base address needed to identify the physical location, such as the street number and street name together, or the closest local equivalent in countries where addresses do not use that exact structure. Use address line 1 for all core location details that describe the main property or thoroughfare. Regardless of how each component of an address is collected from your end-users, they must be combined into address line 1 before sending to Lead. Do not: - split the primary street address across line 1 and line 2 - put only the street number in line 1 and the street name in line 2 - pad line 1 with false or altered data just to satisfy validation
          - `line_2` string — Address line 2 is optional and should be used only for secondary or sub-premise information, such as: - apartment - unit - suite - floor - building - care-of / attention If there is no secondary or sub-premise information, address line 2 should be blank. Do not use address line 2 for any part of the primary street address.
          - `city` string — City.
          - `postal_code` string — Postal Code, required for US addresses. Please follow the following format: US: ^\d5(?:-\d4)?$, CN: ^\d6$, GB: ^[A-Z]{1,2}d[A-Z0-9]? ?d[A-Z]{2}$, JP: ^\d3-\d4$
          - `state` string — State. required for US addresses in 2 character code (e.g. NY).
          - `country` string — ISO3166-1 Alpha-2 country code.
        - `mailing_address` UpdateAddress
          - `line_1` string — Address line 1 is the required primary street-address field. It must contain the full base address needed to identify the physical location, such as the street number and street name together, or the closest local equivalent in countries where addresses do not use that exact structure. Use address line 1 for all core location details that describe the main property or thoroughfare. Regardless of how each component of an address is collected from your end-users, they must be combined into address line 1 before sending to Lead. Do not: - split the primary street address across line 1 and line 2 - put only the street number in line 1 and the street name in line 2 - pad line 1 with false or altered data just to satisfy validation
          - `line_2` string — Address line 2 is optional and should be used only for secondary or sub-premise information, such as: - apartment - unit - suite - floor - building - care-of / attention If there is no secondary or sub-premise information, address line 2 should be blank. Do not use address line 2 for any part of the primary street address.
          - `city` string — City.
          - `postal_code` string — Postal Code, required for US addresses. Please follow the following format: US: ^\d5(?:-\d4)?$, CN: ^\d6$, GB: ^[A-Z]{1,2}d[A-Z0-9]? ?d[A-Z]{2}$, JP: ^\d3-\d4$
          - `state` string — State. required for US addresses in 2 character code (e.g. NY).
          - `country` string — ISO3166-1 Alpha-2 country code.
        - `other_addresses` Address[] — Other addresses for the entity.
          - `line_1` string, required — Address line 1 is the required primary street-address field. It must contain the full base address needed to identify the physical location, such as the street number and street name together, or the closest local equivalent in countries where addresses do not use that exact structure. Use address line 1 for all core location details that describe the main property or thoroughfare. Regardless of how each component of an address is collected from your end-users, they must be combined into address line 1 before sending to Lead. Do not: - split the primary street address across line 1 and line 2 - put only the street number in line 1 and the street name in line 2 - pad line 1 with false or altered data just to satisfy validation
          - `line_2` string — Address line 2 is optional and should be used only for secondary or sub-premise information, such as: - apartment - unit - suite - floor - building - care-of / attention If there is no secondary or sub-premise information, address line 2 should be blank. Do not use address line 2 for any part of the primary street address.
          - `city` string, required — City.
          - `postal_code` string — Postal Code, required for US addresses. Please follow the following format: US: ^\d5(?:-\d4)?$, CN: ^\d6$, GB: ^[A-Z]{1,2}d[A-Z0-9]? ?d[A-Z]{2}$, JP: ^\d3-\d4$
          - `state` string — State. required for US addresses in 2 character code (e.g. NY).
          - `country` string, required — ISO3166-1 Alpha-2 country code.
      - `identification_details` union
        - object
          - `type` string, required — Entity is considered US entity if they have US tax identification. For US entities, US tax identification number as well as other available government-verified identification documents, if collected, are required.
          - `tax_identification` TaxIdentification
            - `type` 'ssn' | 'itin' | 'ein', required — The entity's US tax identification type. - For `individual` entity, `ssn` or `itin` is required. - For `business` entity, `ein` is required. For single-member LLC entities where no EIN is available, `ssn` or `itin` may be used. - For `sole_prop` entity, `ssn` or `itin` or `ein` is required.
            - `value` string, required — The entity's US tax identification number. Must be 9 digits (e.g. XXXXXXXXX). ssn must not start with a 9. ein must begin with a number between 00 and 99. itin must begin with a 9
          - `identification_documents` IdentificationDocument[]
            - `client_document_id` string — Client document ID for the identification document.
            - `type` 'drivers_license' | 'state_or_provincial_id' | 'passport' | 'permanent_residency_id' | 'military_id' | 'national_id' | 'matriculate_id' | 'other' | 'tax_certificate' | 'tax_returns' | 'partnership_agreement' | 'certificate_of_good_standing' | 'formation_document' | 'proof_of_place_on_stock_exchange' | 'name_certificate', required — The entity's government-verified identification document type. This will apply for identification types other than US tax identification. - For `individual` entity, possible types are: `drivers_license`, `state_or_provincial_id`, `passport`, `permanent_residency_id`, `military_id`, `national_id`, `matriculate_id`, `other`. Note that `national_id` and `matriculate_id` are not applicable for `us_entity`. - For `business` entity, possible types are: `tax_certificate`, `tax_returns`, `partnership_agreement`, `certificate_of_good_standing`, `formation_document`, `proof_of_place_on_stock_exchange`, `other`. - For `sole_prop` entity, possible types are: `tax_certificate`, `tax_returns`, `name_certificate`, `drivers_license`, `state_or_provincial_id`, `passport`, `permanent_residency_id`, `military_id`, `national_id`, `matriculate_id`, `other`. Note that `national_id` and `matriculate_id` are not applicable for `us_entity`.
            - `description` string — Description about the identification document. Required if identification document type is `other`.
            - `identification_number` string, required — Unique identification number on the identification document.
            - `expiration_date` string, date — Expiration date of the identification document.
            - `issuing_state` string — Issuing state of the identification document. Must be 2 character code (e.g. NY). If the issuing country is US, this value must be a valid US State.
            - `issuing_country` string, required — Issuing country of the identification document. ISO3166-1 Alpha-2 country code.
        - object
          - `type` string, required — Entity is considered non-US entity if they do not have US tax identification. For non-US entities, at least 1 government-verified identification documents is required.
          - `identification_documents` IdentificationDocument[]
            - `client_document_id` string — Client document ID for the identification document.
            - `type` 'drivers_license' | 'state_or_provincial_id' | 'passport' | 'permanent_residency_id' | 'military_id' | 'national_id' | 'matriculate_id' | 'other' | 'tax_certificate' | 'tax_returns' | 'partnership_agreement' | 'certificate_of_good_standing' | 'formation_document' | 'proof_of_place_on_stock_exchange' | 'name_certificate', required — The entity's government-verified identification document type. This will apply for identification types other than US tax identification. - For `individual` entity, possible types are: `drivers_license`, `state_or_provincial_id`, `passport`, `permanent_residency_id`, `military_id`, `national_id`, `matriculate_id`, `other`. Note that `national_id` and `matriculate_id` are not applicable for `us_entity`. - For `business` entity, possible types are: `tax_certificate`, `tax_returns`, `partnership_agreement`, `certificate_of_good_standing`, `formation_document`, `proof_of_place_on_stock_exchange`, `other`. - For `sole_prop` entity, possible types are: `tax_certificate`, `tax_returns`, `name_certificate`, `drivers_license`, `state_or_provincial_id`, `passport`, `permanent_residency_id`, `military_id`, `national_id`, `matriculate_id`, `other`. Note that `national_id` and `matriculate_id` are not applicable for `us_entity`.
            - `description` string — Description about the identification document. Required if identification document type is `other`.
            - `identification_number` string, required — Unique identification number on the identification document.
            - `expiration_date` string, date — Expiration date of the identification document.
            - `issuing_state` string — Issuing state of the identification document. Must be 2 character code (e.g. NY). If the issuing country is US, this value must be a valid US State.
            - `issuing_country` string, required — Issuing country of the identification document. ISO3166-1 Alpha-2 country code.
      - `additional_documents` AdditionalDocument[]
        - `client_document_id` string — Client document ID for the additional document.
        - `type` 'bank_statement' | 'utility_bills' | 'proof_of_address' | 'investigation_report' | 'financial_statement' | 'public_records' | 'adverse_media' | 'id_selfie' | 'other', required — Type of additional non-government documents being provided to verify entity. Possible values are `bank_statement`, `utility_bills`, `proof_of_address`, `investigation_report`, `financial_statement`, `public_records`, `adverse_media`, `id_selfie`, `other`.
        - `description` string — Description about the identification document. Required if additional document type is `other`.
    - `sole_proprietor` SoleProprietor
      - `entity_id` string, required — Individual entity_id created for the sole proprietor. Data requirements for sole proprietors match those of authorized_signer roles.
    - `rfi_details` RfiDetails
      - `result` 'requested' | 'completed', required — Result of request for information with the end customer. Leave blank if RFI has not been sent to the customer.
      - `requested_at` string, date-time, required — Date time RFI is requested at.
    - `ofac_details` OfacDetails — Details on OFAC on the entity.
      - `result` 'pending' | 'passed' | 'failed', required — OFAC result. Possible values: pending | passed | failed.
      - `screened_at` string, date-time, required — Date time OFAC screen is screened at.
    - `kyc_details` KycDetails — Details on KYC on the entity.
      - `result` 'pending' | 'passed' | 'failed', required — KYC result. Possible values: pending | passed | failed.
      - `screened_at` string, date-time, required — Date time KYC screen is screened at.
    - `credit_details` CreditDetails[]
      - `credit_score` string — Credit score given by the credit bureau. Cannot be above 850. Mutually exclusive with `credit_report_non_score_value`.
      - `credit_report_non_score_value` 'unestablished' | 'frozen' — Indicates the state of a credit file when a numeric score is not available.
      - `credit_report_source` 'equifax' | 'experian' | 'transunion', required — The name of the credit bureau.
      - `credit_pulled_at` string, date-time, required — Date time credit is pulled at.
    - `metadata` Metadata — A set of key-value pairs that can be used to store additional information related to this object.

## Response `200`

Entity object updated.

- union
  - CreateAnIndividualEntityResponse
    - `id` string, required — Unique ID for the Entity object.
    - `client_customer_id` string — Client customer ID for the entity object. Limit of 64 characters.
    - `created_at` string, date-time, required — Timestamp at which the entity object is created.
    - `updated_at` string, date-time, required — Timestamp at which the entity object was last updated.
    - `type` string, required — Type of entity = individual.
    - `intended_roles` IntendedRolesEnum[]
    - `risk_score` 'low' | 'medium' | 'high' — The entity's risk score, mapped to Lead by the client. Client should have provided risk score mapping to Lead.
    - `individual_details` IndividualDetails — Details for the individual entity
      - `first_name` string, required — Legal first name.
      - `preferred_first_name` string — Preferred first name.
      - `middle_name` string — Middle name.
      - `last_name` string, required — Legal last name. Must be at least 2 alphanumeric characters.
      - `date_of_birth` string, date — Date of birth, in YYYY-MM-DD format. Authorized signers and account holders must be 18 years or older.
      - `occupation` string — Occupation / job.
      - `contact_methods` ContactMethod[]
        - union
          - object
            - `type` string, required — ContactMethodType = email.
            - `email` string, required — Must be a valid email address in the form `local-part@domain.tld`. The domain must contain at least one dot. Addresses using `localhost`, IP literals (e.g., user@[127.0.0.1]), or quoted local parts (e.g., "user"@example.com) are not accepted. Only common, real-world email formats are supported.
          - object
            - `type` string, required — ContactMethodType = phone_number. Conforms to E.123 standard
            - `phone_number` string, required — Primary phone number of the entity. Must follow E.123 format.
      - `address_details` AddressDetails
        - `physical_address` Address
          - `line_1` string, required — Address line 1 is the required primary street-address field. It must contain the full base address needed to identify the physical location, such as the street number and street name together, or the closest local equivalent in countries where addresses do not use that exact structure. Use address line 1 for all core location details that describe the main property or thoroughfare. Regardless of how each component of an address is collected from your end-users, they must be combined into address line 1 before sending to Lead. Do not: - split the primary street address across line 1 and line 2 - put only the street number in line 1 and the street name in line 2 - pad line 1 with false or altered data just to satisfy validation
          - `line_2` string — Address line 2 is optional and should be used only for secondary or sub-premise information, such as: - apartment - unit - suite - floor - building - care-of / attention If there is no secondary or sub-premise information, address line 2 should be blank. Do not use address line 2 for any part of the primary street address.
          - `city` string, required — City.
          - `postal_code` string — Postal Code, required for US addresses. Please follow the following format: US: ^\d5(?:-\d4)?$, CN: ^\d6$, GB: ^[A-Z]{1,2}d[A-Z0-9]? ?d[A-Z]{2}$, JP: ^\d3-\d4$
          - `state` string — State. required for US addresses in 2 character code (e.g. NY).
          - `country` string, required — ISO3166-1 Alpha-2 country code.
        - `mailing_address` Address
          - `line_1` string, required — Address line 1 is the required primary street-address field. It must contain the full base address needed to identify the physical location, such as the street number and street name together, or the closest local equivalent in countries where addresses do not use that exact structure. Use address line 1 for all core location details that describe the main property or thoroughfare. Regardless of how each component of an address is collected from your end-users, they must be combined into address line 1 before sending to Lead. Do not: - split the primary street address across line 1 and line 2 - put only the street number in line 1 and the street name in line 2 - pad line 1 with false or altered data just to satisfy validation
          - `line_2` string — Address line 2 is optional and should be used only for secondary or sub-premise information, such as: - apartment - unit - suite - floor - building - care-of / attention If there is no secondary or sub-premise information, address line 2 should be blank. Do not use address line 2 for any part of the primary street address.
          - `city` string, required — City.
          - `postal_code` string — Postal Code, required for US addresses. Please follow the following format: US: ^\d5(?:-\d4)?$, CN: ^\d6$, GB: ^[A-Z]{1,2}d[A-Z0-9]? ?d[A-Z]{2}$, JP: ^\d3-\d4$
          - `state` string — State. required for US addresses in 2 character code (e.g. NY).
          - `country` string, required — ISO3166-1 Alpha-2 country code.
        - `other_addresses` Address[] — Other addresses for the entity.
          - `line_1` string, required — Address line 1 is the required primary street-address field. It must contain the full base address needed to identify the physical location, such as the street number and street name together, or the closest local equivalent in countries where addresses do not use that exact structure. Use address line 1 for all core location details that describe the main property or thoroughfare. Regardless of how each component of an address is collected from your end-users, they must be combined into address line 1 before sending to Lead. Do not: - split the primary street address across line 1 and line 2 - put only the street number in line 1 and the street name in line 2 - pad line 1 with false or altered data just to satisfy validation
          - `line_2` string — Address line 2 is optional and should be used only for secondary or sub-premise information, such as: - apartment - unit - suite - floor - building - care-of / attention If there is no secondary or sub-premise information, address line 2 should be blank. Do not use address line 2 for any part of the primary street address.
          - `city` string, required — City.
          - `postal_code` string — Postal Code, required for US addresses. Please follow the following format: US: ^\d5(?:-\d4)?$, CN: ^\d6$, GB: ^[A-Z]{1,2}d[A-Z0-9]? ?d[A-Z]{2}$, JP: ^\d3-\d4$
          - `state` string — State. required for US addresses in 2 character code (e.g. NY).
          - `country` string, required — ISO3166-1 Alpha-2 country code.
      - `identification_details` union, required
        - object
          - `type` string, required — Entity is considered US entity if they have US tax identification. For US entities, US tax identification number as well as other available government-verified identification documents, if collected, are required.
          - `tax_identification` TaxIdentification
            - `type` 'ssn' | 'itin' | 'ein', required — The entity's US tax identification type. - For `individual` entity, `ssn` or `itin` is required. - For `business` entity, `ein` is required. For single-member LLC entities where no EIN is available, `ssn` or `itin` may be used. - For `sole_prop` entity, `ssn` or `itin` or `ein` is required.
            - `value` string, required — The entity's US tax identification number. Must be 9 digits (e.g. XXXXXXXXX). ssn must not start with a 9. ein must begin with a number between 00 and 99. itin must begin with a 9
          - `identification_documents` IdentificationDocument[]
            - `client_document_id` string — Client document ID for the identification document.
            - `type` 'drivers_license' | 'state_or_provincial_id' | 'passport' | 'permanent_residency_id' | 'military_id' | 'national_id' | 'matriculate_id' | 'other' | 'tax_certificate' | 'tax_returns' | 'partnership_agreement' | 'certificate_of_good_standing' | 'formation_document' | 'proof_of_place_on_stock_exchange' | 'name_certificate', required — The entity's government-verified identification document type. This will apply for identification types other than US tax identification. - For `individual` entity, possible types are: `drivers_license`, `state_or_provincial_id`, `passport`, `permanent_residency_id`, `military_id`, `national_id`, `matriculate_id`, `other`. Note that `national_id` and `matriculate_id` are not applicable for `us_entity`. - For `business` entity, possible types are: `tax_certificate`, `tax_returns`, `partnership_agreement`, `certificate_of_good_standing`, `formation_document`, `proof_of_place_on_stock_exchange`, `other`. - For `sole_prop` entity, possible types are: `tax_certificate`, `tax_returns`, `name_certificate`, `drivers_license`, `state_or_provincial_id`, `passport`, `permanent_residency_id`, `military_id`, `national_id`, `matriculate_id`, `other`. Note that `national_id` and `matriculate_id` are not applicable for `us_entity`.
            - `description` string — Description about the identification document. Required if identification document type is `other`.
            - `identification_number` string, required — Unique identification number on the identification document.
            - `expiration_date` string, date — Expiration date of the identification document.
            - `issuing_state` string — Issuing state of the identification document. Must be 2 character code (e.g. NY). If the issuing country is US, this value must be a valid US State.
            - `issuing_country` string, required — Issuing country of the identification document. ISO3166-1 Alpha-2 country code.
        - object
          - `type` string, required — Entity is considered non-US entity if they do not have US tax identification. For non-US entities, at least 1 government-verified identification documents is required.
          - `identification_documents` IdentificationDocument[]
            - `client_document_id` string — Client document ID for the identification document.
            - `type` 'drivers_license' | 'state_or_provincial_id' | 'passport' | 'permanent_residency_id' | 'military_id' | 'national_id' | 'matriculate_id' | 'other' | 'tax_certificate' | 'tax_returns' | 'partnership_agreement' | 'certificate_of_good_standing' | 'formation_document' | 'proof_of_place_on_stock_exchange' | 'name_certificate', required — The entity's government-verified identification document type. This will apply for identification types other than US tax identification. - For `individual` entity, possible types are: `drivers_license`, `state_or_provincial_id`, `passport`, `permanent_residency_id`, `military_id`, `national_id`, `matriculate_id`, `other`. Note that `national_id` and `matriculate_id` are not applicable for `us_entity`. - For `business` entity, possible types are: `tax_certificate`, `tax_returns`, `partnership_agreement`, `certificate_of_good_standing`, `formation_document`, `proof_of_place_on_stock_exchange`, `other`. - For `sole_prop` entity, possible types are: `tax_certificate`, `tax_returns`, `name_certificate`, `drivers_license`, `state_or_provincial_id`, `passport`, `permanent_residency_id`, `military_id`, `national_id`, `matriculate_id`, `other`. Note that `national_id` and `matriculate_id` are not applicable for `us_entity`.
            - `description` string — Description about the identification document. Required if identification document type is `other`.
            - `identification_number` string, required — Unique identification number on the identification document.
            - `expiration_date` string, date — Expiration date of the identification document.
            - `issuing_state` string — Issuing state of the identification document. Must be 2 character code (e.g. NY). If the issuing country is US, this value must be a valid US State.
            - `issuing_country` string, required — Issuing country of the identification document. ISO3166-1 Alpha-2 country code.
      - `additional_documents` AdditionalDocument[]
        - `client_document_id` string — Client document ID for the additional document.
        - `type` 'bank_statement' | 'utility_bills' | 'proof_of_address' | 'investigation_report' | 'financial_statement' | 'public_records' | 'adverse_media' | 'id_selfie' | 'other', required — Type of additional non-government documents being provided to verify entity. Possible values are `bank_statement`, `utility_bills`, `proof_of_address`, `investigation_report`, `financial_statement`, `public_records`, `adverse_media`, `id_selfie`, `other`.
        - `description` string — Description about the identification document. Required if additional document type is `other`.
    - `rfi_details` RfiDetails
      - `result` 'requested' | 'completed', required — Result of request for information with the end customer. Leave blank if RFI has not been sent to the customer.
      - `requested_at` string, date-time, required — Date time RFI is requested at.
    - `ofac_details` OfacDetails — Details on OFAC on the entity.
      - `result` 'pending' | 'passed' | 'failed', required — OFAC result. Possible values: pending | passed | failed.
      - `screened_at` string, date-time, required — Date time OFAC screen is screened at.
    - `kyc_details` KycDetails — Details on KYC on the entity.
      - `result` 'pending' | 'passed' | 'failed', required — KYC result. Possible values: pending | passed | failed.
      - `screened_at` string, date-time, required — Date time KYC screen is screened at.
    - `credit_details` CreditDetails[]
      - `credit_score` string — Credit score given by the credit bureau. Cannot be above 850. Mutually exclusive with `credit_report_non_score_value`.
      - `credit_report_non_score_value` 'unestablished' | 'frozen' — Indicates the state of a credit file when a numeric score is not available.
      - `credit_report_source` 'equifax' | 'experian' | 'transunion', required — The name of the credit bureau.
      - `credit_pulled_at` string, date-time, required — Date time credit is pulled at.
    - `role_details` RoleDetails[]
      - `name` 'authorized_user' | 'authorized_signer' | 'account_holder' — The entity's intended role. Lead highly recommends using this field to confirm data requirements for different roles to minimize errors later. In the event more than 1 role is passed in and at least 1 role doesn’t pass validation, the request will not succeed. It will be an all or nothing behavior. Lead currently supports: * `authorized_user`: Individual entity with restricted access to the account, without legal responsibility. Only applies to individual entity. * `authorized_signer`: Individual entity allowed to sign on behalf of the account holder, without legal responsibility. Only applies to individual entity. * `account_holder`: Entity with full control and legal responsibility for the account. Applies to all entity types.
      - `status` 'active' | 'inactive' — Role Details Status
      - `criteria_details` CriteriaDetails[]
        - `failed_checks` string[]
        - `entity_id` string
    - `metadata` Metadata — A set of key-value pairs that can be used to store additional information related to this object.
  - CreateABusinessEntityResponse
    - `id` string, required — Unique ID for the Entity object.
    - `client_customer_id` string — Client customer ID for the entity object. Limit of 64 characters.
    - `created_at` string, date-time, required — Timestamp at which the entity object is created.
    - `updated_at` string, date-time, required — Timestamp at which the entity object was last updated.
    - `type` string, required — Type of entity = business.
    - `intended_roles` IntendedRolesEnum[]
    - `risk_score` 'low' | 'medium' | 'high' — The entity's risk score, mapped to Lead by the client. Client should have provided risk score mapping to Lead.
    - `business_details` BusinessDetails, required — Details for the business entity
      - `type` 'corporation' | 'partnership' | 'sole_prop' | 'llc' | 'trust' | 'cooperative' | 'other' — Business Types. Possible business types are `corporation`, `partnership`, `sole_prop`, `llc`, `trust`, `cooperative`, `other`. - For business entity, cannot use `sole_prop` as business type. - For sole_prop entity, must use `sole_prop` as business type.
      - `name` string, required — Legal name of the business. Must be at least 2 characters.
      - `gross_annual_revenue` string — Business gross revenue for prior fiscal year.
      - `currency_code` string — A three-letter currency code as defined in ISO 4217.
      - `industry` string[] — NAICS code(s) for the applicable industries. 2-6 digits of NAICS code(s) are accepted and valid NAICS codes can be found on naics.com/search. Please refer to 2022 NAICS Reference Files.
      - `doing_business_as` string — Business name if the business operates under a different name.
      - `website` string — The website of the business. Must start with http:// or https://.
      - `contact_methods` ContactMethod[]
        - union
          - object
            - `type` string, required — ContactMethodType = email.
            - `email` string, required — Must be a valid email address in the form `local-part@domain.tld`. The domain must contain at least one dot. Addresses using `localhost`, IP literals (e.g., user@[127.0.0.1]), or quoted local parts (e.g., "user"@example.com) are not accepted. Only common, real-world email formats are supported.
          - object
            - `type` string, required — ContactMethodType = phone_number. Conforms to E.123 standard
            - `phone_number` string, required — Primary phone number of the entity. Must follow E.123 format.
      - `address_details` AddressDetails, required
        - `physical_address` Address
          - `line_1` string, required — Address line 1 is the required primary street-address field. It must contain the full base address needed to identify the physical location, such as the street number and street name together, or the closest local equivalent in countries where addresses do not use that exact structure. Use address line 1 for all core location details that describe the main property or thoroughfare. Regardless of how each component of an address is collected from your end-users, they must be combined into address line 1 before sending to Lead. Do not: - split the primary street address across line 1 and line 2 - put only the street number in line 1 and the street name in line 2 - pad line 1 with false or altered data just to satisfy validation
          - `line_2` string — Address line 2 is optional and should be used only for secondary or sub-premise information, such as: - apartment - unit - suite - floor - building - care-of / attention If there is no secondary or sub-premise information, address line 2 should be blank. Do not use address line 2 for any part of the primary street address.
          - `city` string, required — City.
          - `postal_code` string — Postal Code, required for US addresses. Please follow the following format: US: ^\d5(?:-\d4)?$, CN: ^\d6$, GB: ^[A-Z]{1,2}d[A-Z0-9]? ?d[A-Z]{2}$, JP: ^\d3-\d4$
          - `state` string — State. required for US addresses in 2 character code (e.g. NY).
          - `country` string, required — ISO3166-1 Alpha-2 country code.
        - `mailing_address` Address
          - `line_1` string, required — Address line 1 is the required primary street-address field. It must contain the full base address needed to identify the physical location, such as the street number and street name together, or the closest local equivalent in countries where addresses do not use that exact structure. Use address line 1 for all core location details that describe the main property or thoroughfare. Regardless of how each component of an address is collected from your end-users, they must be combined into address line 1 before sending to Lead. Do not: - split the primary street address across line 1 and line 2 - put only the street number in line 1 and the street name in line 2 - pad line 1 with false or altered data just to satisfy validation
          - `line_2` string — Address line 2 is optional and should be used only for secondary or sub-premise information, such as: - apartment - unit - suite - floor - building - care-of / attention If there is no secondary or sub-premise information, address line 2 should be blank. Do not use address line 2 for any part of the primary street address.
          - `city` string, required — City.
          - `postal_code` string — Postal Code, required for US addresses. Please follow the following format: US: ^\d5(?:-\d4)?$, CN: ^\d6$, GB: ^[A-Z]{1,2}d[A-Z0-9]? ?d[A-Z]{2}$, JP: ^\d3-\d4$
          - `state` string — State. required for US addresses in 2 character code (e.g. NY).
          - `country` string, required — ISO3166-1 Alpha-2 country code.
        - `other_addresses` Address[] — Other addresses for the entity.
          - `line_1` string, required — Address line 1 is the required primary street-address field. It must contain the full base address needed to identify the physical location, such as the street number and street name together, or the closest local equivalent in countries where addresses do not use that exact structure. Use address line 1 for all core location details that describe the main property or thoroughfare. Regardless of how each component of an address is collected from your end-users, they must be combined into address line 1 before sending to Lead. Do not: - split the primary street address across line 1 and line 2 - put only the street number in line 1 and the street name in line 2 - pad line 1 with false or altered data just to satisfy validation
          - `line_2` string — Address line 2 is optional and should be used only for secondary or sub-premise information, such as: - apartment - unit - suite - floor - building - care-of / attention If there is no secondary or sub-premise information, address line 2 should be blank. Do not use address line 2 for any part of the primary street address.
          - `city` string, required — City.
          - `postal_code` string — Postal Code, required for US addresses. Please follow the following format: US: ^\d5(?:-\d4)?$, CN: ^\d6$, GB: ^[A-Z]{1,2}d[A-Z0-9]? ?d[A-Z]{2}$, JP: ^\d3-\d4$
          - `state` string — State. required for US addresses in 2 character code (e.g. NY).
          - `country` string, required — ISO3166-1 Alpha-2 country code.
      - `identification_details` union, required
        - object
          - `type` string, required — Entity is considered US entity if they have US tax identification. For US entities, US tax identification number as well as other available government-verified identification documents, if collected, are required.
          - `tax_identification` TaxIdentification
            - `type` 'ssn' | 'itin' | 'ein', required — The entity's US tax identification type. - For `individual` entity, `ssn` or `itin` is required. - For `business` entity, `ein` is required. For single-member LLC entities where no EIN is available, `ssn` or `itin` may be used. - For `sole_prop` entity, `ssn` or `itin` or `ein` is required.
            - `value` string, required — The entity's US tax identification number. Must be 9 digits (e.g. XXXXXXXXX). ssn must not start with a 9. ein must begin with a number between 00 and 99. itin must begin with a 9
          - `identification_documents` IdentificationDocument[]
            - `client_document_id` string — Client document ID for the identification document.
            - `type` 'drivers_license' | 'state_or_provincial_id' | 'passport' | 'permanent_residency_id' | 'military_id' | 'national_id' | 'matriculate_id' | 'other' | 'tax_certificate' | 'tax_returns' | 'partnership_agreement' | 'certificate_of_good_standing' | 'formation_document' | 'proof_of_place_on_stock_exchange' | 'name_certificate', required — The entity's government-verified identification document type. This will apply for identification types other than US tax identification. - For `individual` entity, possible types are: `drivers_license`, `state_or_provincial_id`, `passport`, `permanent_residency_id`, `military_id`, `national_id`, `matriculate_id`, `other`. Note that `national_id` and `matriculate_id` are not applicable for `us_entity`. - For `business` entity, possible types are: `tax_certificate`, `tax_returns`, `partnership_agreement`, `certificate_of_good_standing`, `formation_document`, `proof_of_place_on_stock_exchange`, `other`. - For `sole_prop` entity, possible types are: `tax_certificate`, `tax_returns`, `name_certificate`, `drivers_license`, `state_or_provincial_id`, `passport`, `permanent_residency_id`, `military_id`, `national_id`, `matriculate_id`, `other`. Note that `national_id` and `matriculate_id` are not applicable for `us_entity`.
            - `description` string — Description about the identification document. Required if identification document type is `other`.
            - `identification_number` string, required — Unique identification number on the identification document.
            - `expiration_date` string, date — Expiration date of the identification document.
            - `issuing_state` string — Issuing state of the identification document. Must be 2 character code (e.g. NY). If the issuing country is US, this value must be a valid US State.
            - `issuing_country` string, required — Issuing country of the identification document. ISO3166-1 Alpha-2 country code.
        - object
          - `type` string, required — Entity is considered non-US entity if they do not have US tax identification. For non-US entities, at least 1 government-verified identification documents is required.
          - `identification_documents` IdentificationDocument[]
            - `client_document_id` string — Client document ID for the identification document.
            - `type` 'drivers_license' | 'state_or_provincial_id' | 'passport' | 'permanent_residency_id' | 'military_id' | 'national_id' | 'matriculate_id' | 'other' | 'tax_certificate' | 'tax_returns' | 'partnership_agreement' | 'certificate_of_good_standing' | 'formation_document' | 'proof_of_place_on_stock_exchange' | 'name_certificate', required — The entity's government-verified identification document type. This will apply for identification types other than US tax identification. - For `individual` entity, possible types are: `drivers_license`, `state_or_provincial_id`, `passport`, `permanent_residency_id`, `military_id`, `national_id`, `matriculate_id`, `other`. Note that `national_id` and `matriculate_id` are not applicable for `us_entity`. - For `business` entity, possible types are: `tax_certificate`, `tax_returns`, `partnership_agreement`, `certificate_of_good_standing`, `formation_document`, `proof_of_place_on_stock_exchange`, `other`. - For `sole_prop` entity, possible types are: `tax_certificate`, `tax_returns`, `name_certificate`, `drivers_license`, `state_or_provincial_id`, `passport`, `permanent_residency_id`, `military_id`, `national_id`, `matriculate_id`, `other`. Note that `national_id` and `matriculate_id` are not applicable for `us_entity`.
            - `description` string — Description about the identification document. Required if identification document type is `other`.
            - `identification_number` string, required — Unique identification number on the identification document.
            - `expiration_date` string, date — Expiration date of the identification document.
            - `issuing_state` string — Issuing state of the identification document. Must be 2 character code (e.g. NY). If the issuing country is US, this value must be a valid US State.
            - `issuing_country` string, required — Issuing country of the identification document. ISO3166-1 Alpha-2 country code.
      - `additional_documents` AdditionalDocument[]
        - `client_document_id` string — Client document ID for the additional document.
        - `type` 'bank_statement' | 'utility_bills' | 'proof_of_address' | 'investigation_report' | 'financial_statement' | 'public_records' | 'adverse_media' | 'id_selfie' | 'other', required — Type of additional non-government documents being provided to verify entity. Possible values are `bank_statement`, `utility_bills`, `proof_of_address`, `investigation_report`, `financial_statement`, `public_records`, `adverse_media`, `id_selfie`, `other`.
        - `description` string — Description about the identification document. Required if additional document type is `other`.
    - `beneficial_owners` BeneficialOwners[]
      - `entity_id` string, required — Individual entity_id created for the beneficial owner. Data requirements for beneficial owners match those of authorized_signer roles.
      - `ownership_percentage` string — Percentage ownership (0-100.00 or 0-1.00 for decimal representation).
      - `relationship_established_at` string, date — The date the relationship was established.
    - `control_persons` ControlPersons[]
      - `entity_id` string, required — Individual entity_id created for the control person. Data requirements for control persons match those of authorized_signer roles.
      - `title` string, required — The title of this control person.
      - `relationship_established_at` string, date — The date the relationship was established.
    - `rfi_details` RfiDetails
      - `result` 'requested' | 'completed', required — Result of request for information with the end customer. Leave blank if RFI has not been sent to the customer.
      - `requested_at` string, date-time, required — Date time RFI is requested at.
    - `ofac_details` OfacDetails — Details on OFAC on the entity.
      - `result` 'pending' | 'passed' | 'failed', required — OFAC result. Possible values: pending | passed | failed.
      - `screened_at` string, date-time, required — Date time OFAC screen is screened at.
    - `kyc_details` KycDetails — Details on KYC on the entity.
      - `result` 'pending' | 'passed' | 'failed', required — KYC result. Possible values: pending | passed | failed.
      - `screened_at` string, date-time, required — Date time KYC screen is screened at.
    - `credit_details` CreditDetails[]
      - `credit_score` string — Credit score given by the credit bureau. Cannot be above 850. Mutually exclusive with `credit_report_non_score_value`.
      - `credit_report_non_score_value` 'unestablished' | 'frozen' — Indicates the state of a credit file when a numeric score is not available.
      - `credit_report_source` 'equifax' | 'experian' | 'transunion', required — The name of the credit bureau.
      - `credit_pulled_at` string, date-time, required — Date time credit is pulled at.
    - `role_details` RoleDetails[]
      - `name` 'authorized_user' | 'authorized_signer' | 'account_holder' — The entity's intended role. Lead highly recommends using this field to confirm data requirements for different roles to minimize errors later. In the event more than 1 role is passed in and at least 1 role doesn’t pass validation, the request will not succeed. It will be an all or nothing behavior. Lead currently supports: * `authorized_user`: Individual entity with restricted access to the account, without legal responsibility. Only applies to individual entity. * `authorized_signer`: Individual entity allowed to sign on behalf of the account holder, without legal responsibility. Only applies to individual entity. * `account_holder`: Entity with full control and legal responsibility for the account. Applies to all entity types.
      - `status` 'active' | 'inactive' — Role Details Status
      - `criteria_details` CriteriaDetails[]
        - `failed_checks` string[]
        - `entity_id` string
    - `metadata` Metadata — A set of key-value pairs that can be used to store additional information related to this object.
  - CreateASolePropEntityResponse
    - `id` string, required — Unique ID for the Entity object.
    - `client_customer_id` string — Client customer ID for the entity object. Limit of 64 characters.
    - `created_at` string, date-time, required — Timestamp at which the entity object is created.
    - `updated_at` string, date-time, required — Timestamp at which the entity object was last updated.
    - `type` string, required — Type of entity = sole_prop.
    - `intended_roles` IntendedRolesEnum[]
    - `risk_score` 'low' | 'medium' | 'high' — The entity's risk score, mapped to Lead by the client. Client should have provided risk score mapping to Lead.
    - `business_details` BusinessDetails, required — Details for the business entity
      - `type` 'corporation' | 'partnership' | 'sole_prop' | 'llc' | 'trust' | 'cooperative' | 'other' — Business Types. Possible business types are `corporation`, `partnership`, `sole_prop`, `llc`, `trust`, `cooperative`, `other`. - For business entity, cannot use `sole_prop` as business type. - For sole_prop entity, must use `sole_prop` as business type.
      - `name` string, required — Legal name of the business. Must be at least 2 characters.
      - `gross_annual_revenue` string — Business gross revenue for prior fiscal year.
      - `currency_code` string — A three-letter currency code as defined in ISO 4217.
      - `industry` string[] — NAICS code(s) for the applicable industries. 2-6 digits of NAICS code(s) are accepted and valid NAICS codes can be found on naics.com/search. Please refer to 2022 NAICS Reference Files.
      - `doing_business_as` string — Business name if the business operates under a different name.
      - `website` string — The website of the business. Must start with http:// or https://.
      - `contact_methods` ContactMethod[]
        - union
          - object
            - `type` string, required — ContactMethodType = email.
            - `email` string, required — Must be a valid email address in the form `local-part@domain.tld`. The domain must contain at least one dot. Addresses using `localhost`, IP literals (e.g., user@[127.0.0.1]), or quoted local parts (e.g., "user"@example.com) are not accepted. Only common, real-world email formats are supported.
          - object
            - `type` string, required — ContactMethodType = phone_number. Conforms to E.123 standard
            - `phone_number` string, required — Primary phone number of the entity. Must follow E.123 format.
      - `address_details` AddressDetails, required
        - `physical_address` Address
          - `line_1` string, required — Address line 1 is the required primary street-address field. It must contain the full base address needed to identify the physical location, such as the street number and street name together, or the closest local equivalent in countries where addresses do not use that exact structure. Use address line 1 for all core location details that describe the main property or thoroughfare. Regardless of how each component of an address is collected from your end-users, they must be combined into address line 1 before sending to Lead. Do not: - split the primary street address across line 1 and line 2 - put only the street number in line 1 and the street name in line 2 - pad line 1 with false or altered data just to satisfy validation
          - `line_2` string — Address line 2 is optional and should be used only for secondary or sub-premise information, such as: - apartment - unit - suite - floor - building - care-of / attention If there is no secondary or sub-premise information, address line 2 should be blank. Do not use address line 2 for any part of the primary street address.
          - `city` string, required — City.
          - `postal_code` string — Postal Code, required for US addresses. Please follow the following format: US: ^\d5(?:-\d4)?$, CN: ^\d6$, GB: ^[A-Z]{1,2}d[A-Z0-9]? ?d[A-Z]{2}$, JP: ^\d3-\d4$
          - `state` string — State. required for US addresses in 2 character code (e.g. NY).
          - `country` string, required — ISO3166-1 Alpha-2 country code.
        - `mailing_address` Address
          - `line_1` string, required — Address line 1 is the required primary street-address field. It must contain the full base address needed to identify the physical location, such as the street number and street name together, or the closest local equivalent in countries where addresses do not use that exact structure. Use address line 1 for all core location details that describe the main property or thoroughfare. Regardless of how each component of an address is collected from your end-users, they must be combined into address line 1 before sending to Lead. Do not: - split the primary street address across line 1 and line 2 - put only the street number in line 1 and the street name in line 2 - pad line 1 with false or altered data just to satisfy validation
          - `line_2` string — Address line 2 is optional and should be used only for secondary or sub-premise information, such as: - apartment - unit - suite - floor - building - care-of / attention If there is no secondary or sub-premise information, address line 2 should be blank. Do not use address line 2 for any part of the primary street address.
          - `city` string, required — City.
          - `postal_code` string — Postal Code, required for US addresses. Please follow the following format: US: ^\d5(?:-\d4)?$, CN: ^\d6$, GB: ^[A-Z]{1,2}d[A-Z0-9]? ?d[A-Z]{2}$, JP: ^\d3-\d4$
          - `state` string — State. required for US addresses in 2 character code (e.g. NY).
          - `country` string, required — ISO3166-1 Alpha-2 country code.
        - `other_addresses` Address[] — Other addresses for the entity.
          - `line_1` string, required — Address line 1 is the required primary street-address field. It must contain the full base address needed to identify the physical location, such as the street number and street name together, or the closest local equivalent in countries where addresses do not use that exact structure. Use address line 1 for all core location details that describe the main property or thoroughfare. Regardless of how each component of an address is collected from your end-users, they must be combined into address line 1 before sending to Lead. Do not: - split the primary street address across line 1 and line 2 - put only the street number in line 1 and the street name in line 2 - pad line 1 with false or altered data just to satisfy validation
          - `line_2` string — Address line 2 is optional and should be used only for secondary or sub-premise information, such as: - apartment - unit - suite - floor - building - care-of / attention If there is no secondary or sub-premise information, address line 2 should be blank. Do not use address line 2 for any part of the primary street address.
          - `city` string, required — City.
          - `postal_code` string — Postal Code, required for US addresses. Please follow the following format: US: ^\d5(?:-\d4)?$, CN: ^\d6$, GB: ^[A-Z]{1,2}d[A-Z0-9]? ?d[A-Z]{2}$, JP: ^\d3-\d4$
          - `state` string — State. required for US addresses in 2 character code (e.g. NY).
          - `country` string, required — ISO3166-1 Alpha-2 country code.
      - `identification_details` union, required
        - object
          - `type` string, required — Entity is considered US entity if they have US tax identification. For US entities, US tax identification number as well as other available government-verified identification documents, if collected, are required.
          - `tax_identification` TaxIdentification
            - `type` 'ssn' | 'itin' | 'ein', required — The entity's US tax identification type. - For `individual` entity, `ssn` or `itin` is required. - For `business` entity, `ein` is required. For single-member LLC entities where no EIN is available, `ssn` or `itin` may be used. - For `sole_prop` entity, `ssn` or `itin` or `ein` is required.
            - `value` string, required — The entity's US tax identification number. Must be 9 digits (e.g. XXXXXXXXX). ssn must not start with a 9. ein must begin with a number between 00 and 99. itin must begin with a 9
          - `identification_documents` IdentificationDocument[]
            - `client_document_id` string — Client document ID for the identification document.
            - `type` 'drivers_license' | 'state_or_provincial_id' | 'passport' | 'permanent_residency_id' | 'military_id' | 'national_id' | 'matriculate_id' | 'other' | 'tax_certificate' | 'tax_returns' | 'partnership_agreement' | 'certificate_of_good_standing' | 'formation_document' | 'proof_of_place_on_stock_exchange' | 'name_certificate', required — The entity's government-verified identification document type. This will apply for identification types other than US tax identification. - For `individual` entity, possible types are: `drivers_license`, `state_or_provincial_id`, `passport`, `permanent_residency_id`, `military_id`, `national_id`, `matriculate_id`, `other`. Note that `national_id` and `matriculate_id` are not applicable for `us_entity`. - For `business` entity, possible types are: `tax_certificate`, `tax_returns`, `partnership_agreement`, `certificate_of_good_standing`, `formation_document`, `proof_of_place_on_stock_exchange`, `other`. - For `sole_prop` entity, possible types are: `tax_certificate`, `tax_returns`, `name_certificate`, `drivers_license`, `state_or_provincial_id`, `passport`, `permanent_residency_id`, `military_id`, `national_id`, `matriculate_id`, `other`. Note that `national_id` and `matriculate_id` are not applicable for `us_entity`.
            - `description` string — Description about the identification document. Required if identification document type is `other`.
            - `identification_number` string, required — Unique identification number on the identification document.
            - `expiration_date` string, date — Expiration date of the identification document.
            - `issuing_state` string — Issuing state of the identification document. Must be 2 character code (e.g. NY). If the issuing country is US, this value must be a valid US State.
            - `issuing_country` string, required — Issuing country of the identification document. ISO3166-1 Alpha-2 country code.
        - object
          - `type` string, required — Entity is considered non-US entity if they do not have US tax identification. For non-US entities, at least 1 government-verified identification documents is required.
          - `identification_documents` IdentificationDocument[]
            - `client_document_id` string — Client document ID for the identification document.
            - `type` 'drivers_license' | 'state_or_provincial_id' | 'passport' | 'permanent_residency_id' | 'military_id' | 'national_id' | 'matriculate_id' | 'other' | 'tax_certificate' | 'tax_returns' | 'partnership_agreement' | 'certificate_of_good_standing' | 'formation_document' | 'proof_of_place_on_stock_exchange' | 'name_certificate', required — The entity's government-verified identification document type. This will apply for identification types other than US tax identification. - For `individual` entity, possible types are: `drivers_license`, `state_or_provincial_id`, `passport`, `permanent_residency_id`, `military_id`, `national_id`, `matriculate_id`, `other`. Note that `national_id` and `matriculate_id` are not applicable for `us_entity`. - For `business` entity, possible types are: `tax_certificate`, `tax_returns`, `partnership_agreement`, `certificate_of_good_standing`, `formation_document`, `proof_of_place_on_stock_exchange`, `other`. - For `sole_prop` entity, possible types are: `tax_certificate`, `tax_returns`, `name_certificate`, `drivers_license`, `state_or_provincial_id`, `passport`, `permanent_residency_id`, `military_id`, `national_id`, `matriculate_id`, `other`. Note that `national_id` and `matriculate_id` are not applicable for `us_entity`.
            - `description` string — Description about the identification document. Required if identification document type is `other`.
            - `identification_number` string, required — Unique identification number on the identification document.
            - `expiration_date` string, date — Expiration date of the identification document.
            - `issuing_state` string — Issuing state of the identification document. Must be 2 character code (e.g. NY). If the issuing country is US, this value must be a valid US State.
            - `issuing_country` string, required — Issuing country of the identification document. ISO3166-1 Alpha-2 country code.
      - `additional_documents` AdditionalDocument[]
        - `client_document_id` string — Client document ID for the additional document.
        - `type` 'bank_statement' | 'utility_bills' | 'proof_of_address' | 'investigation_report' | 'financial_statement' | 'public_records' | 'adverse_media' | 'id_selfie' | 'other', required — Type of additional non-government documents being provided to verify entity. Possible values are `bank_statement`, `utility_bills`, `proof_of_address`, `investigation_report`, `financial_statement`, `public_records`, `adverse_media`, `id_selfie`, `other`.
        - `description` string — Description about the identification document. Required if additional document type is `other`.
    - `sole_proprietor` SoleProprietor, required
      - `entity_id` string, required — Individual entity_id created for the sole proprietor. Data requirements for sole proprietors match those of authorized_signer roles.
    - `rfi_details` RfiDetails
      - `result` 'requested' | 'completed', required — Result of request for information with the end customer. Leave blank if RFI has not been sent to the customer.
      - `requested_at` string, date-time, required — Date time RFI is requested at.
    - `ofac_details` OfacDetails — Details on OFAC on the entity.
      - `result` 'pending' | 'passed' | 'failed', required — OFAC result. Possible values: pending | passed | failed.
      - `screened_at` string, date-time, required — Date time OFAC screen is screened at.
    - `kyc_details` KycDetails — Details on KYC on the entity.
      - `result` 'pending' | 'passed' | 'failed', required — KYC result. Possible values: pending | passed | failed.
      - `screened_at` string, date-time, required — Date time KYC screen is screened at.
    - `credit_details` CreditDetails[]
      - `credit_score` string — Credit score given by the credit bureau. Cannot be above 850. Mutually exclusive with `credit_report_non_score_value`.
      - `credit_report_non_score_value` 'unestablished' | 'frozen' — Indicates the state of a credit file when a numeric score is not available.
      - `credit_report_source` 'equifax' | 'experian' | 'transunion', required — The name of the credit bureau.
      - `credit_pulled_at` string, date-time, required — Date time credit is pulled at.
    - `role_details` RoleDetails[]
      - `name` 'authorized_user' | 'authorized_signer' | 'account_holder' — The entity's intended role. Lead highly recommends using this field to confirm data requirements for different roles to minimize errors later. In the event more than 1 role is passed in and at least 1 role doesn’t pass validation, the request will not succeed. It will be an all or nothing behavior. Lead currently supports: * `authorized_user`: Individual entity with restricted access to the account, without legal responsibility. Only applies to individual entity. * `authorized_signer`: Individual entity allowed to sign on behalf of the account holder, without legal responsibility. Only applies to individual entity. * `account_holder`: Entity with full control and legal responsibility for the account. Applies to all entity types.
      - `status` 'active' | 'inactive' — Role Details Status
      - `criteria_details` CriteriaDetails[]
        - `failed_checks` string[]
        - `entity_id` string
    - `metadata` Metadata — A set of key-value pairs that can be used to store additional information related to this object.

## Other responses

- `400` — Your request parameters did not validate.
- `404` — id passed in doesn't correspond to an entity
- `409` — A request to update this entity is already in progress.
- `422` — We couldn't parse your request body, please check that your request body is valid JSON.
- `429` — Too many requests. Please slow down your request rate.
- `500` — Server error. Please try your request again.
- `503` — Service unavailable. Please try your request again.

---

[API](https://skmtc.net/lead/apis/lead-bank.md) · [All operations](https://skmtc.net/lead/apis/lead-bank/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/lead/lead-bank/revisions/25c2a92d55e2/schema)