Lead Bank

Lead Bank Entity API

The Entity API from Lead Bank — 2 operation(s) for entity.

GitHub OpenAPI

Operations 4

POST /v0/entities Create an entity #
GET /v0/entities Retrieve an entity by client customer id #
PATCH /v0/entities/{id} Update an entity #
GET /v0/entities/{id} Retrieve an entity by entity id #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/lead-bank/refs/heads/main/openapi/lead-bank-entity-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/lead-bank-entity-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

lead-bank-entity-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Lead Bank Account Number Entity API
  description: Lead Bank's APIs
  version: v1.0
servers:
- url: https://api.sandbox.lead.bank
- url: https://api.lead.bank
security:
- bearerAuth: []
tags:
- name: Entity
paths:
  /v0/entities:
    post:
      tags:
      - Entity
      operationId: create-an-entity
      summary: Create an entity
      description: Create an Individual, Sole Prop or Business Entity.
      parameters:
      - name: Idempotency-Key
        in: header
        description: Idempotency key
        required: true
        schema:
          type: string
          maxLength: 255
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAnEntityRequestBody'
      responses:
        '200':
          description: Entity object created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateAnEntitySuccessResponse'
        '400':
          description: Your request parameters did not validate.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
        '409':
          description: An entity with the same client_customer_id already exists.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
        '422':
          description: We couldn't parse your request body, please check that your request body is valid JSON.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
        '429':
          description: Too many requests. Please slow down your request rate.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
        '500':
          description: Server error. Please try your request again.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
        '503':
          description: Service unavailable. Please try your request again.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
    get:
      tags:
      - Entity
      operationId: retrieve-an-entity-by-client-customer-id
      summary: Retrieve an entity by client customer id
      description: Retrieve an entity by the client customer id
      parameters:
      - name: client_customer_id
        in: query
        required: true
        description: Client Customer ID of the entity object you want to retrieve.
        schema:
          type: string
      responses:
        '200':
          description: An entity object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveAnEntitySuccessResponse'
        '400':
          description: Your request parameters did not validate.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
        '404':
          description: id passed in doesn't correspond to an entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
        '429':
          description: Too many requests. Please slow down your request rate.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
        '500':
          description: Server error. Please try your request again.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
        '503':
          description: Service unavailable. Please try your request again.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
  /v0/entities/{id}:
    patch:
      tags:
      - Entity
      operationId: Update-an-entity
      summary: Update an entity
      description: '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.

        '
      parameters:
      - name: id
        in: path
        required: true
        description: Entity ID
        schema:
          type: string
      - name: Idempotency-Key
        in: header
        description: Idempotency key
        required: true
        schema:
          type: string
          maxLength: 255
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateAnEntityRequestBody'
      responses:
        '200':
          description: Entity object updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateAnEntitySuccessResponse'
        '400':
          description: Your request parameters did not validate.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
        '404':
          description: id passed in doesn't correspond to an entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
        '409':
          description: A request to update this entity is already in progress.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
        '422':
          description: We couldn't parse your request body, please check that your request body is valid JSON.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
        '429':
          description: Too many requests. Please slow down your request rate.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
        '500':
          description: Server error. Please try your request again.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
        '503':
          description: Service unavailable. Please try your request again.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
    get:
      tags:
      - Entity
      operationId: retrieve-an-entity-by-entity-id
      summary: Retrieve an entity by entity id
      description: Retrieve an entity by entity id
      parameters:
      - name: id
        in: path
        required: true
        description: Entity ID of the entity object you want to retrieve.
        schema:
          type: string
      responses:
        '200':
          description: An entity object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveAnEntitySuccessResponse'
        '400':
          description: Your request parameters did not validate.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
        '404':
          description: id passed in doesn't correspond to an entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
        '429':
          description: Too many requests. Please slow down your request rate.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
        '500':
          description: Server error. Please try your request again.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
        '503':
          description: Service unavailable. Please try your request again.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
components:
  schemas:
    TaxIdentificationTypeEnum:
      type: string
      enum:
      - ssn
      - itin
      - ein
      description: '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.

        '
    ContactMethodPhone:
      title: Phone Number
      type: object
      required:
      - type
      - phone_number
      properties:
        type:
          $ref: '#/components/schemas/ContactMethodTypePhone'
        phone_number:
          type: string
          description: Primary phone number of the entity. Must follow E.123 format.
    NonUsEntityIndividual:
      title: Non US Entity
      type: object
      required:
      - type
      properties:
        type:
          $ref: '#/components/schemas/NonUsEntityTypeEnum'
        identification_documents:
          type: array
          items:
            $ref: '#/components/schemas/IdentificationDocument'
    KycDetails:
      type: object
      required:
      - result
      - screened_at
      properties:
        result:
          $ref: '#/components/schemas/KycDetailsResultEnum'
        screened_at:
          type: string
          format: date-time
          description: Date time KYC screen is screened at.
      description: Details on KYC on the entity.
    ContactMethodTypePhone:
      type: string
      pattern: ^phone_number$
      default: phone_number
      example: +22 607 123 4567
      description: ContactMethodType = phone_number. Conforms to E.123 standard
    UpdateAddress:
      type: object
      properties:
        line_1:
          type: string
          description: Address line 1.
        line_2:
          type: string
          description: Address line 2.
        city:
          type: string
          description: City.
        postal_code:
          type: string
          description: '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:
          type: string
          description: State. required for US addresses in 2 character code (e.g. NY).
        country:
          type: string
          description: ISO3166-1 Alpha-2 country code.
    EntityTypeSoleProp:
      type: string
      pattern: ^sole_prop$
      default: sole_prop
      description: Type of entity = sole_prop.
    OfacDetails:
      type: object
      required:
      - result
      - screened_at
      properties:
        result:
          $ref: '#/components/schemas/OfacDetailsResultEnum'
        screened_at:
          type: string
          format: date-time
          description: Date time OFAC screen is screened at.
      description: Details on OFAC on the entity.
    CreateAnIndividualEntityRequestBody:
      title: Individual
      type: object
      required:
      - type
      - individual_details
      properties:
        client_customer_id:
          type: string
          maxLength: 64
          description: Client customer ID for the entity object. Limit of 64 characters.
        type:
          $ref: '#/components/schemas/EntityTypeIndividual'
        intended_roles:
          type: array
          items:
            $ref: '#/components/schemas/IntendedRolesEnum'
          example: 'Possible values: authorized_user, authorized_signer, account_holder. 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. For type = business, sole_prop, only account_holder should be provided'
        risk_score:
          $ref: '#/components/schemas/EntityRiskScoreEnum'
        individual_details:
          $ref: '#/components/schemas/IndividualDetails'
        rfi_details:
          $ref: '#/components/schemas/RfiDetails'
        ofac_details:
          $ref: '#/components/schemas/OfacDetails'
        kyc_details:
          $ref: '#/components/schemas/KycDetails'
        credit_details:
          type: array
          items:
            $ref: '#/components/schemas/CreditDetails'
        metadata:
          $ref: '#/components/schemas/Metadata'
    CreateAnEntityRequestBody:
      oneOf:
      - $ref: '#/components/schemas/CreateAnIndividualEntityRequestBody'
      - $ref: '#/components/schemas/CreateABusinessEntityRequestBody'
      - $ref: '#/components/schemas/CreateASolePropEntityRequestBody'
      discriminator:
        propertyName: type
        mapping:
          individual: '#/components/schemas/CreateAnIndividualEntityRequestBody'
          business: '#/components/schemas/CreateABusinessEntityRequestBody'
          sole_prop: '#/components/schemas/CreateASolePropEntityRequestBody'
    EntityTypeIndividual:
      type: string
      pattern: ^individual$
      default: individual
      description: Type of entity = individual.
    RetrieveAnEntitySuccessResponse:
      oneOf:
      - $ref: '#/components/schemas/CreateAnIndividualEntityResponse'
      - $ref: '#/components/schemas/CreateABusinessEntityResponse'
      - $ref: '#/components/schemas/CreateASolePropEntityResponse'
      discriminator:
        propertyName: type
        mapping:
          individual: '#/components/schemas/CreateAnIndividualEntityResponse'
          business: '#/components/schemas/CreateABusinessEntityResponse'
          sole_prop: '#/components/schemas/CreateASolePropEntityResponse'
    UpdateAddressDetails:
      type: object
      properties:
        physical_address:
          $ref: '#/components/schemas/UpdateAddress'
          description: Physical address for the entity. Physical addresses must not be P.O. boxes, registered agent addresses or in prohibited countries.
        mailing_address:
          $ref: '#/components/schemas/UpdateAddress'
          description: Mailing address for the entity.
        other_addresses:
          type: array
          description: Other addresses for the entity.
          items:
            $ref: '#/components/schemas/Address'
    UpdateABusinessEntityRequestBody:
      title: Business
      type: object
      required:
      - type
      properties:
        type:
          $ref: '#/components/schemas/EntityTypeBusiness'
        intended_roles:
          type: array
          items:
            $ref: '#/components/schemas/IntendedRolesEnum'
          example: 'Possible values: authorized_user, authorized_signer, account_holder. 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. For type = business, sole_prop, only account_holder should be provided'
        risk_score:
          $ref: '#/components/schemas/EntityRiskScoreEnum'
        business_details:
          $ref: '#/components/schemas/UpdateBusinessDetails'
        beneficial_owners:
          type: array
          items:
            $ref: '#/components/schemas/BeneficialOwners'
        control_persons:
          type: array
          items:
            $ref: '#/components/schemas/ControlPersons'
        rfi_details:
          $ref: '#/components/schemas/RfiDetails'
        ofac_details:
          $ref: '#/components/schemas/OfacDetails'
        kyc_details:
          $ref: '#/components/schemas/KycDetails'
        credit_details:
          type: array
          items:
            $ref: '#/components/schemas/CreditDetails'
        metadata:
          $ref: '#/components/schemas/Metadata'
    SoleProprietor:
      type: object
      required:
      - entity_id
      properties:
        entity_id:
          type: string
          minLength: 1
          description: Individual entity_id created for the sole proprietor. Data requirements for sole proprietors match those of authorized_signer roles.
    IdentificationDetailsBusiness:
      type: object
      oneOf:
      - $ref: '#/components/schemas/UsEntity'
      - $ref: '#/components/schemas/NonUsEntityBusiness'
      discriminator:
        propertyName: type
        mapping:
          us_entity: '#/components/schemas/UsEntity'
          non_us_entity: '#/components/schemas/NonUsEntityBusiness'
    APIError:
      type: object
      properties:
        code:
          type: string
          description: The error code.
        title:
          type: string
          description: The error title.
        detail:
          type: string
          description: A detailed error description.
        status:
          type: string
          description: The HTTP status code.
        invalid_parameters:
          type: array
          description: Invalid request parameters with reasons, if applicable.
          items:
            $ref: '#/components/schemas/InvalidParameterDetail'
        instance:
          type: string
          description: The object causing this specific occurrence of the error, if applicable.
    ContactMethod:
      type: object
      oneOf:
      - $ref: '#/components/schemas/ContactMethodEmail'
      - $ref: '#/components/schemas/ContactMethodPhone'
      discriminator:
        propertyName: type
        mapping:
          email: '#/components/schemas/ContactMethodEmail'
          phone_number: '#/components/schemas/ContactMethodPhone'
    EntityRiskScoreEnum:
      type: string
      enum:
      - low
      - medium
      - high
      description: The entity's risk score, mapped to Lead by the client. Client should have provided risk score mapping to Lead.
    CreateAnEntitySuccessResponse:
      oneOf:
      - $ref: '#/components/schemas/CreateAnIndividualEntityResponse'
      - $ref: '#/components/schemas/CreateABusinessEntityResponse'
      - $ref: '#/components/schemas/CreateASolePropEntityResponse'
      discriminator:
        propertyName: type
        mapping:
          individual: '#/components/schemas/CreateAnIndividualEntityResponse'
          business: '#/components/schemas/CreateABusinessEntityResponse'
          sole_prop: '#/components/schemas/CreateASolePropEntityResponse'
    UpdateAnEntitySuccessResponse:
      oneOf:
      - $ref: '#/components/schemas/CreateAnIndividualEntityResponse'
      - $ref: '#/components/schemas/CreateABusinessEntityResponse'
      - $ref: '#/components/schemas/CreateASolePropEntityResponse'
      discriminator:
        propertyName: type
        mapping:
          individual: '#/components/schemas/CreateAnIndividualEntityResponse'
          business: '#/components/schemas/CreateABusinessEntityResponse'
          sole_prop: '#/components/schemas/CreateASolePropEntityResponse'
    CreateABusinessEntityResponse:
      title: Business
      type: object
      required:
      - id
      - type
      - business_details
      - created_at
      - updated_at
      properties:
        id:
          type: string
          description: Unique ID for the Entity object.
        client_customer_id:
          type: string
          maxLength: 64
          description: Client customer ID for the entity object. Limit of 64 characters.
        created_at:
          type: string
          format: date-time
          description: Timestamp at which the entity object is created.
        updated_at:
          type: string
          format: date-time
          description: Timestamp at which the entity object was last updated.
        type:
          $ref: '#/components/schemas/EntityTypeBusiness'
        intended_roles:
          type: array
          items:
            $ref: '#/components/schemas/IntendedRolesEnum'
          example: 'Possible values: authorized_user, authorized_signer, account_holder. 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. For type = business, sole_prop, only account_holder should be provided'
        risk_score:
          $ref: '#/components/schemas/EntityRiskScoreEnum'
        business_details:
          $ref: '#/components/schemas/BusinessDetails'
        beneficial_owners:
          type: array
          items:
            $ref: '#/components/schemas/BeneficialOwners'
        control_persons:
          type: array
          items:
            $ref: '#/components/schemas/ControlPersons'
        rfi_details:
          $ref: '#/components/schemas/RfiDetails'
        ofac_details:
          $ref: '#/components/schemas/OfacDetails'
        kyc_details:
          $ref: '#/components/schemas/KycDetails'
        credit_details:
          type: array
          items:
            $ref: '#/components/schemas/CreditDetails'
        role_details:
          type: array
          items:
            $ref: '#/components/schemas/RoleDetails'
        metadata:
          $ref: '#/components/schemas/Metadata'
    IdentificationDocumentsTypeEnum:
      type: string
      enum:
      - 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
      description: '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`.

        '
    KycDetailsResultEnum:
      type: string
      enum:
      - pending
      - passed
      - failed
      description: 'KYC result. Possible values: pending | passed | failed. '
    ControlPersons:
      type: object
      required:
      - entity_id
      - title
      properties:
        entity_id:
          type: string
          description: Individual entity_id created for the control person. Data requirements for control persons match those of authorized_signer roles.
        title:
          type: string
          description: The title of this control person.
        relationship_established_at:
          type: string
          format: date
          description: The date the relationship was established.
    UpdateIndividualDetails:
      type: object
      properties:
        first_name:
          type: string
          description: Legal first name. Must be at least 2 character.
          example: Lucy
        preferred_first_name:
          type: string
          description: Preferred first name.
          example: Lu
        middle_name:
          type: string
          description: Middle name.
          example: Reginald
        last_name:
          type: string
          description: Legal last name. Must be at least 2 character.
          example: Collins
        date_of_birth:
          type: string
          format: date
          description: Date of birth, in YYYY-MM-DD format.  Authorized signers and account holders must be 18 years or older.
          example: '2002-02-15'
        occupation:
          type: string
          description: Occupation / job.
          example: Author
        contact_methods:
          type: array
          items:
            $ref: '#/components/schemas/ContactMethod'
        address_details:
          $ref: '#/components/schemas/UpdateAddressDetails'
        identification_details:
          $ref: '#/components/schemas/IdentificationDetailsIndividual'
        additional_documents:
          type: array
          items:
            $ref: '#/components/schemas/AdditionalDocument'
      description: Details for the individual entity
    AddressDetails:
      type: object
      properties:
        physical_address:
          $ref: '#/components/schemas/Address'
          description: Physical address for the entity. Physical addresses must not be P.O. boxes, registered agent addresses or in prohibited countries.
        mailing_address:
          $ref: '#/components/schemas/Address'
          description: Mailing address for the entity.
        other_addresses:
          type: array
          description: Other addresses for the entity.
          items:
            $ref: '#/components/schemas/Address'
    CreditDetails:
      type: object
      required:
      - credit_score
      - credit_report_source
      - credit_pulled_at
      properties:
        credit_score:
          type: string
          description: Credit score given by the credit bureau. Cannot be above 999.
        credit_report_source:
          $ref: '#/components/schemas/CreditReportSourceEnum'
        credit_pulled_at:
          type: string
          format: date-time
          description: Date time credit is pulled at.
      description: Details on credit data from credit bureaus on the entity.
    RfiDetails:
      type: object
      required:
      - result
      - requested_at
      properties:
        result:
          $ref: '#/components/schemas/RfiDetailsResultEnum'
        requested_at:
          type: string
          format: date-time
          description: Date time RFI is requested at.
    Metadata:
      type: object
      additionalProperties:
        type: string
      description: A set of key-value pairs that can be used to store additional information related to this object.
    ContactMethodEmail:
      title: Email
      type: object
      required:
      - type
      - email
      properties:
        type:
          $ref: '#/components/schemas/ContactMethodTypeEmail'
        email:
          type: string
          description: 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.
          example: abc@gmail.com
    OfacDetailsResultEnum:
      type: string
      enum:
      - pending
      - passed
      - failed
      description: 'OFAC result. Possible values: pending | passed | failed. '
    UsEntity:
      title: US Entity
      type: object
      required:
      - type
      properties:
        type:
          $ref: '#/components/schemas/UsEntityTypeEnum'
        tax_identification:
          $ref: '#/components/schemas/TaxIdentification'
        identification_documents:
          type: array
          items:
            $ref: '#/components/schemas/IdentificationDocument'
    UpdateAnEntityRequestBody:
      oneOf:
      - $ref: '#/components/schemas/UpdateAnIndividualEntityRequestBody'
      - $ref: '#/components/schemas/UpdateABusinessEntityRequestBody'
      - $ref: '#/components/schemas/UpdateASolePropEntityRequestBody'
      discriminator:
        propertyName: type
        mapping:
          individual: '#/components/schemas/UpdateAnIndividualEntityRequestBody'
          business: '#/components/schemas/UpdateABusinessEntityRequestBody'
          sole_prop: '#/components/schemas/UpdateASolePropEntityRequestBody'
    NonUsEntityBusiness:
      title: Non US Entity
      type: object
      required:
      - type
      properties:
        type:
          $ref: '#/components/schemas/NonUsEntityTypeEnum'
        identification_documents:
          type: array
          items:
            $ref: '#/components/schemas/IdentificationDocument'
    EntityTypeBusiness:
      type: string
      pattern: ^business$
      default: business
      description: Type of entity = business.
    CriteriaDetails:
      type: object
      properties:
        failed_checks:
          type: array
          items:
            type: string
        entity_id:
          type: string
    Address:
      type: object
      required:
      - line_1
      - city
      - country
      properties:
        line_1:
          type: string
          description: Address line 1.
          example: 123 Main St.
        line_2:
          type: string
          description: Address line 2.
          example: Apt 25
        city:
          type: string
          description: City.
          example: Denver
        postal_code:
          type: string
          description: '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$'
          example: 80014
        state:
          type: string
          description: State. required for US addresses in 2 character code (e.g. NY).
          example: CO
        country:
          type: string
          description: ISO3166-1 Alpha-2 country code.
          example: US
    TaxIdentification:
      type: object
      required:
      - type
      - value
      properties:
        type:
          $ref: '#/components/schemas/TaxIdentificationTypeEnum'
        value:
          type: string
          description: 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
          pattern: ^\d{9}$
    AdditionalDocumentTypeEnum:
      type: string
      enum:
      - bank_statement
      - utility_bills
      - proof_of_address
      - investigation_report
      - financial_statement
      - public_records
      - adverse_media
      - id_selfie
      - other
      description: 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`.
    IdentificationDocument:
      type: object
      required:
      - type
      - identification_number
      - issuing_country
      properties:
        client_document_id:
          type: string
          description: Client document ID for the identification document.
        type:
          $ref: '#/components/schemas/IdentificationDocumentsTypeEnum'
        description:
          type: string
          description: Description about the identification document. Required if identification document type is `other`.
        identification_number:
          type: string
          description: Unique identification number on the identification document.
        expiration_date:
          type: string
          format: date
          description: Expiration date of the identification document.
        issuing_state:
          type: string
          description: 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:
          type: string
          description: Issuing country of the identification document. ISO3166-1 Alpha-2 country code.
    RoleDetailsStatus:
      type: string
      description: Role Details Status
      example: active
      enum:
      - active
      - inactive
    BusinessTypeEnum:
      type: string
      enum:
      - corporation
      - partnership
      - sole_prop
      - llc
      - trust
      - cooperative
      - other
      description: 'Business Types. Possible bu

# --- truncated at 32 KB (50 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/lead-bank/refs/heads/main/openapi/lead-bank-entity-api-openapi.yml