> ## Documentation Index
> Fetch the complete documentation index at: https://docs.localpayment.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 创建实体

注册自然人（INDIVIDUAL）或法人实体（COMPANY）及其身份证明文件。实体将以 PENDING\_KYC 状态创建，且不含文件；之后请通过“上传证明”上传支持文件。

* 创建时会验证最低 KYC 数据：INDIVIDUAL 需提供 name 和 lastname，COMPANY 需提供 name。否则 API 将返回 422 INCOMPLETE\_KYC\_DATA。
* 未知属性将被拒绝，并返回 400 VALIDATION\_ERROR。任何额外数据请放入 attributes。
* 国家/地区代码必须为 ISO 3166-1 alpha-3 格式（BRA，而不是 BR）。
* 税务 ID（CPF、CNPJ、CUIT、RFC 等）是一种文件，而不是实体的字段。请在 document 中发送；创建时不接受 documents\[]（400 VALIDATION\_ERROR）。
* 其他文件（身份证件、地址证明、公司章程）请通过“添加文件”添加。
* 请保留响应中的 document.documentId：它是用于向主文件上传文件的 docId。

错误使用带有固定 `code` 的 `application/problem+json`。完整目录：[实体状态和错误代码](https://docs.localpayment.com/zh/reference/entity-statuses-and-error-codes.md)。


## OpenAPI

````yaml openapi/zh/localpayment.json POST /api/entity/v1/entities
openapi: 3.1.0
info:
  version: '1.0'
  title: Localpayment
  contact:
    name: Support
    url: mailto:support@localpayment.com
servers:
  - url: https://api.stage.localpayment.com
    description: Stage
security:
  - token: []
paths:
  /api/entity/v1/entities:
    post:
      summary: 创建实体
      operationId: create-entity
      parameters:
        - name: Authorization
          in: header
          description: >-
            用于身份验证的 Bearer
            访问令牌。该令牌可从[获取访问令牌](/zh/reference/get-token)或[刷新访问令牌](/zh/reference/refresh-token)endpoint
            获取。系统将据此识别您的商户账户和执行操作的用户。
          required: true
          schema:
            type: string
            examples:
              - Bearer <your_access_token>
        - name: X-Correlation-ID
          in: header
          description: 跟踪标识符（UUID）。会在响应中原样返回；如未提供，则由 Localpayment 生成。
          required: false
          schema:
            type: string
            examples:
              - 0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                externalId:
                  type: string
                  description: 您为该实体提供的专属标识符。每个商户的标识符必须唯一，长度为 1 至 64 个字符。
                  examples:
                    - f47ac10b-58cc-4372-a567-0e02b2c3d479
                type:
                  type: string
                  description: INDIVIDUAL（自然人）或 COMPANY（法人实体）。
                  enum:
                    - INDIVIDUAL
                    - COMPANY
                  examples:
                    - COMPANY
                name:
                  type: string
                  description: 名字（INDIVIDUAL）或法定名称（COMPANY）。最多 255 个字符。
                  examples:
                    - Example Company S.A.
                lastname:
                  type: string
                  description: 姓氏。个人必填。最多 255 个字符。
                  examples:
                    - Doe
                birthdate:
                  type: string
                  format: date
                  description: YYYY-MM-DD。建议用于 INDIVIDUAL。
                  examples:
                    - '1990-01-15'
                gender:
                  type: string
                  description: MALE、FEMALE、OTHER 或 UNDISCLOSED。
                  enum:
                    - MALE
                    - FEMALE
                    - OTHER
                    - UNDISCLOSED
                  examples:
                    - FEMALE
                nationality:
                  type: string
                  description: ISO 3166-1 alpha-3（BRA、ARG、MEX）。
                  examples:
                    - BRA
                birthCountry:
                  type: string
                  description: ISO 3166-1 alpha-3。
                  examples:
                    - BRA
                residenceCountry:
                  type: string
                  description: ISO 3166-1 alpha-3。对于 COMPANY，为税务居住国。
                  examples:
                    - BRA
                occupation:
                  type: string
                  description: 职业。最多100个字符。
                  examples:
                    - Engineer
                isPep:
                  type: boolean
                  description: 政治公众人物。默认值为 false。
                  examples:
                    - false
                incorporationDate:
                  type: string
                  format: date
                  description: YYYY-MM-DD。仅限 COMPANY。
                  examples:
                    - '2020-01-15'
                incorporationCountry:
                  type: string
                  description: ISO 3166-1 alpha-3。仅限 COMPANY。
                  examples:
                    - BRA
                website:
                  type: string
                  description: 公司网站。最多 255 个字符。
                  examples:
                    - https://www.example.com
                legalRepresentativeName:
                  type: string
                  description: 法定代表人（公司）名称。最多 255 个字符。
                  examples:
                    - Jane Doe
                email:
                  type: string
                  description: 联系邮箱。最多 255 个字符。
                  examples:
                    - test@example.com
                phone:
                  type: object
                  description: 联系电话，每部分仅输入数字。
                  properties:
                    countryCode:
                      type: string
                      description: 不含 + 的国家/地区电话区号（55），1 至 4 位数字。
                      examples:
                        - '55'
                    areaCode:
                      type: string
                      description: 区号（11），1 到 5 位数字。
                      examples:
                        - '11'
                    number:
                      type: string
                      description: 本地号码（999990001），4 至 15 位数字。发送 phone 时必填。
                      examples:
                        - '999990000'
                address:
                  type: object
                  description: 邮寄地址。提供时必须填写国家/地区。
                  properties:
                    street:
                      type: string
                      description: 街道名称，最多 256 个字符。
                      examples:
                        - Rua Exemplo
                    number:
                      type: string
                      description: 门牌号，最多 20 个字符。
                      examples:
                        - '100'
                    line2:
                      type: string
                      description: 附加地址行（公寓、楼层、套房），最多 256 个字符。
                      examples:
                        - Sala 100
                    line3:
                      type: string
                      description: 第二行附加地址，最多 256 个字符。
                      examples:
                        - Torre A
                    city:
                      type: string
                      description: 城市，最多 100 个字符。
                      examples:
                        - São Paulo
                    state:
                      type: string
                      description: 州或省，最多 100 个字符。请使用 ISO 3166-2 代码（SP）。
                      examples:
                        - SP
                    zipCode:
                      type: string
                      description: 邮政编码，最多 20 个字符。
                      examples:
                        - 01310-100
                    country:
                      type: string
                      description: ISO 3166-1 alpha-3。发送地址时必填。
                      examples:
                        - BRA
                    comment:
                      type: string
                      description: 其他地址信息（楼层、公寓、参考说明），最多 255 个字符。
                      examples:
                        - Sala 100
                attributes:
                  type: object
                  description: 由您的自定义字段架构定义的自定义字段（请参阅“自定义字段”）。最大 64 KB。
                document:
                  type: object
                  description: 实体的身份证明文档（税号或身份证件）。它将成为主要文档。其他文档随后通过“添加文档”添加。
                  properties:
                    type:
                      type: string
                      description: 请参阅文档和证明类型。
                      enum:
                        - DNI
                        - NATIONAL_ID
                        - DRIVER_LICENSE
                        - PASSPORT
                        - CE
                        - CC
                        - CUIT
                        - CUIL
                        - RFC
                        - CURP
                        - CPF
                        - CNPJ
                        - RUC
                        - NIT
                        - TAX_ID
                        - ARTICLES_OF_INCORPORATION
                        - POWER_OF_ATTORNEY
                        - TAX_CERTIFICATE
                        - PAYSLIP
                        - ARCA_REGISTRATION
                        - PROOF_OF_ADDRESS
                        - PROOF_OF_FUNDS
                        - OTHER
                      examples:
                        - CNPJ
                    id:
                      type: string
                      description: 签发的文件编号，1 至 30 个字符。与 type 一起在您的商户内唯一。
                      examples:
                        - '00000000000100'
                    issuingCountry:
                      type: string
                      description: ISO 3166-1 alpha-3。
                      examples:
                        - BRA
                    issueDate:
                      type: string
                      format: date
                      description: YYYY-MM-DD。
                      examples:
                        - '2024-01-15'
                    expirationDate:
                      type: string
                      format: date
                      description: YYYY-MM-DD。过去的日期会将该文档标记为 EXPIRED。
                      examples:
                        - '2034-01-15'
                    metadata:
                      type: object
                      description: 文档的自由格式元数据。
                  required:
                    - type
                    - id
              required:
                - externalId
                - type
                - name
                - document
            examples:
              Example 1 - INDIVIDUAL:
                value:
                  externalId: 550e8400-e29b-41d4-a716-446655440000
                  type: INDIVIDUAL
                  name: Jane
                  lastname: Doe
                  birthdate: '1990-01-15'
                  nationality: BRA
                  birthCountry: BRA
                  residenceCountry: BRA
                  isPep: false
                  email: jane.doe@example.com
                  phone:
                    countryCode: '55'
                    areaCode: '11'
                    number: '999990001'
                  address:
                    street: Rua Exemplo
                    number: '123'
                    city: São Paulo
                    state: SP
                    zipCode: 01310-100
                    country: BRA
                  document:
                    type: CPF
                    id: '00000000000'
                    issuingCountry: BRA
              Example 2 - COMPANY example:
                value:
                  externalId: f47ac10b-58cc-4372-a567-0e02b2c3d479
                  type: COMPANY
                  name: Example Company S.A.
                  incorporationCountry: BRA
                  incorporationDate: '2020-01-15'
                  website: https://www.example.com
                  email: test@example.com
                  phone:
                    countryCode: '55'
                    areaCode: '11'
                    number: '999990000'
                  legalRepresentativeName: Jane Doe
                  isPep: false
                  address:
                    street: Rua Exemplo
                    number: '100'
                    city: São Paulo
                    state: SP
                    zipCode: 01310-100
                    country: BRA
                    line2: Sala 100
                    line3: Torre A
                  document:
                    type: CNPJ
                    id: '00000000000100'
                    issuingCountry: BRA
                  attributes:
                    reasonForAccountOpening: receive_payments_for_goods_and_services
                    sourceOfFundsAndIncome: sales_of_goods_and_services
                    numberOfEmployees: 11-50
                    estimatedAnnualRevenueUsd: 1m_to_10m
                    estimatedMonthlyVolumeUsd: '50000'
                    businessActivityDescription: >-
                      Online retail of home goods. Receives payments from end
                      customers in Brazil via PIX.
                    countryTaxResidence: BRA
                    socialMedia: https://www.linkedin.com/company/example
                    emailPixKey: test@example.com
      responses:
        '201':
          description: 已创建。
          content:
            application/json:
              schema:
                type: object
                properties:
                  internalId:
                    type: string
                    examples:
                      - 5aced5da-40c1-4bec-85ff-c8cd1bcb4526
                    format: uuid
                    description: Localpayment 的实体标识符。请在其他所有 Entities endpoint 中使用它。
                  externalId:
                    type: string
                    examples:
                      - 550e8400-e29b-41d4-a716-446655440000
                    description: 您发送的标识符。
                  type:
                    type: string
                    examples:
                      - INDIVIDUAL
                    enum:
                      - INDIVIDUAL
                      - COMPANY
                    description: INDIVIDUAL 或 COMPANY。
                  status:
                    type: string
                    examples:
                      - PENDING_KYC
                    enum:
                      - PENDING_KYC
                      - IN_REVIEW
                      - ACTIVE
                      - REJECTED
                      - BLOCKED
                      - CLOSED
                    description: 实体状态。请参阅实体状态和错误代码。
                  name:
                    type: string
                    examples:
                      - Jane
                  lastname:
                    type: string
                    examples:
                      - Doe
                  birthdate:
                    type: string
                    examples:
                      - '1990-01-15'
                    format: date
                  gender:
                    type:
                      - string
                      - 'null'
                  nationality:
                    type: string
                    examples:
                      - BRA
                  birthCountry:
                    type: string
                    examples:
                      - BRA
                  residenceCountry:
                    type: string
                    examples:
                      - BRA
                  occupation:
                    type:
                      - string
                      - 'null'
                  isPep:
                    type: boolean
                    examples:
                      - false
                  incorporationDate:
                    type:
                      - string
                      - 'null'
                    format: date
                  incorporationCountry:
                    type:
                      - string
                      - 'null'
                  website:
                    type:
                      - string
                      - 'null'
                  legalRepresentativeName:
                    type:
                      - string
                      - 'null'
                  email:
                    type: string
                    examples:
                      - jane.doe@example.com
                  phone:
                    type: object
                    properties:
                      countryCode:
                        type: string
                        examples:
                          - '55'
                      areaCode:
                        type: string
                        examples:
                          - '11'
                      number:
                        type: string
                        examples:
                          - '999990001'
                  address:
                    type: object
                    properties:
                      street:
                        type: string
                        examples:
                          - Rua Exemplo
                      city:
                        type: string
                        examples:
                          - São Paulo
                      state:
                        type: string
                        examples:
                          - SP
                      zipCode:
                        type: string
                        examples:
                          - 01310-100
                      number:
                        type: string
                        examples:
                          - '123'
                      comment:
                        type:
                          - string
                          - 'null'
                      country:
                        type: string
                        examples:
                          - BRA
                      line2:
                        type:
                          - string
                          - 'null'
                      line3:
                        type:
                          - string
                          - 'null'
                  attributes:
                    type:
                      - object
                      - 'null'
                  documentationStatus:
                    type: string
                    examples:
                      - NO_FILES
                    enum:
                      - NO_FILES
                      - PARTIAL
                      - COMPLETE
                    description: >-
                      NO_FILES、PARTIAL 或
                      COMPLETE：表示已申报的文件中是没有、部分还是全部至少包含一个文件。它衡量的是文件是否存在，而非是否获批。
                  document:
                    type: object
                    properties:
                      documentId:
                        type: string
                        examples:
                          - 2e16d844-4fa9-4295-9a21-83ec32ef241a
                        format: uuid
                      entityId:
                        type: string
                        examples:
                          - 5aced5da-40c1-4bec-85ff-c8cd1bcb4526
                        format: uuid
                      type:
                        type: string
                        examples:
                          - CPF
                        enum:
                          - DNI
                          - NATIONAL_ID
                          - DRIVER_LICENSE
                          - PASSPORT
                          - CE
                          - CC
                          - CUIT
                          - CUIL
                          - RFC
                          - CURP
                          - CPF
                          - CNPJ
                          - RUC
                          - NIT
                          - TAX_ID
                          - ARTICLES_OF_INCORPORATION
                          - POWER_OF_ATTORNEY
                          - TAX_CERTIFICATE
                          - PAYSLIP
                          - ARCA_REGISTRATION
                          - PROOF_OF_ADDRESS
                          - PROOF_OF_FUNDS
                          - OTHER
                        description: INDIVIDUAL 或 COMPANY。
                      id:
                        type: string
                        examples:
                          - '00000000000'
                      issuingCountry:
                        type: string
                        examples:
                          - BRA
                      issueDate:
                        type:
                          - string
                          - 'null'
                        format: date
                      expirationDate:
                        type:
                          - string
                          - 'null'
                        format: date
                      isPrimary:
                        type: boolean
                        examples:
                          - true
                      status:
                        type: string
                        examples:
                          - PENDING
                        enum:
                          - PENDING
                          - VERIFIED
                          - REJECTED
                          - EXPIRED
                        description: >-
                          派生的文档状态：如果 expirationDate 已过，则为
                          EXPIRED；如果任何有效证明文件被拒绝，则为 REJECTED；如果所有有效证明文件均已批准，则为
                          VERIFIED；否则为 PENDING。
                      metadata:
                        type:
                          - object
                          - 'null'
                      proofs:
                        type: array
                        items:
                          type: object
                      createdAt:
                        type: string
                        examples:
                          - '2024-01-15T17:03:10Z'
                        format: date-time
                        description: ISO 8601 UTC 时间戳。
                      updatedAt:
                        type: string
                        examples:
                          - '2024-01-15T17:03:10Z'
                        format: date-time
                        description: ISO 8601 UTC 时间戳。
                    description: 主要文档，包含其 documentId（上传文件时需要）、派生的状态以及当前的 proofs[]。
                  documents:
                    type: array
                    items:
                      type: object
                    description: 其他已声明的文档（主要文档仅出现在 document 中），结构相同。
                  version:
                    type: integer
                    examples:
                      - 0
                    description: 实体版本。等于 ETag 标头；在 PATCH 请求中将其作为 If-Match 发送回。
                  createdAt:
                    type: string
                    examples:
                      - '2024-01-15T17:03:10Z'
                    format: date-time
                    description: ISO 8601 UTC 时间戳。
                  updatedAt:
                    type: string
                    examples:
                      - '2024-01-15T17:03:10Z'
                    format: date-time
                    description: ISO 8601 UTC 时间戳。
                  customFieldSchemaVersion:
                    type:
                      - integer
                      - 'null'
                    description: 用于验证属性的自定义字段架构版本，或 null。
              examples:
                Example 1:
                  value:
                    internalId: 5aced5da-40c1-4bec-85ff-c8cd1bcb4526
                    externalId: 550e8400-e29b-41d4-a716-446655440000
                    type: INDIVIDUAL
                    status: PENDING_KYC
                    name: Jane
                    lastname: Doe
                    birthdate: '1990-01-15'
                    gender: null
                    nationality: BRA
                    birthCountry: BRA
                    residenceCountry: BRA
                    occupation: null
                    isPep: false
                    incorporationDate: null
                    incorporationCountry: null
                    website: null
                    legalRepresentativeName: null
                    email: jane.doe@example.com
                    phone:
                      countryCode: '55'
                      areaCode: '11'
                      number: '999990001'
                    address:
                      street: Rua Exemplo
                      city: São Paulo
                      state: SP
                      zipCode: 01310-100
                      number: '123'
                      comment: null
                      country: BRA
                      line2: null
                      line3: null
                    attributes: null
                    documentationStatus: NO_FILES
                    document:
                      documentId: 2e16d844-4fa9-4295-9a21-83ec32ef241a
                      entityId: 5aced5da-40c1-4bec-85ff-c8cd1bcb4526
                      type: CPF
                      id: '00000000000'
                      issuingCountry: BRA
                      issueDate: null
                      expirationDate: null
                      isPrimary: true
                      status: PENDING
                      metadata: null
                      proofs: []
                      createdAt: '2024-01-15T17:03:10Z'
                      updatedAt: '2024-01-15T17:03:10Z'
                    documents: []
                    version: 0
                    createdAt: '2024-01-15T17:03:10Z'
                    updatedAt: '2024-01-15T17:03:10Z'
                    customFieldSchemaVersion: null
          headers:
            ETag:
              description: 实体版本。在“更新实体”时，将其作为 If-Match 标头发送回。
              schema:
                type: string
                examples:
                  - '"0"'
        '400':
          description: >-
            错误请求。验证错误：缺少字段、标头、路径或查询参数，或者参数未知或无效。details[]
            列出了字段和问题。自定义字段无效：属性不符合您的自定义字段架构。details[] 列出了字段和问题。
          content:
            application/problem+json:
              schema:
                type: object
                description: RFC 9457 问题详情（application/problem+json）。
                properties:
                  type:
                    type: string
                    examples:
                      - about:blank
                  title:
                    type: string
                    description: 问题简述。
                  status:
                    type: integer
                    description: HTTP状态码。
                  detail:
                    type: string
                    description: 易于理解的解释。
                  instance:
                    type: string
                    description: 请求路径。
                  code:
                    type: string
                    description: 稳定的机器可读错误代码。根据此值进行分支。
                  correlationId:
                    type: string
                    format: uuid
                    description: 请求标识符。联系客服时请提供此标识符。
                    examples:
                      - 0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10
                  details:
                    type: array
                    description: 出错字段（如适用）。
                    items:
                      type: object
                      properties:
                        field:
                          type: string
                          examples:
                            - numberOfEmployees
                        issue:
                          type: string
                          examples:
                            - NOT_IN_OPTIONS
              examples:
                Example 1 - VALIDATION_ERROR:
                  value:
                    type: about:blank
                    title: Validation error
                    status: 400
                    detail: >-
                      A field, header, path or query parameter is missing,
                      unknown or invalid. details[] lists field and issue.
                    instance: /api/entity/v1/entities
                    code: VALIDATION_ERROR
                    correlationId: 0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10
                    details:
                      - field: externalId
                        issue: REQUIRED
                Example 2 - CUSTOM_FIELDS_INVALID:
                  value:
                    type: about:blank
                    title: Validation error
                    status: 400
                    detail: >-
                      attributes does not satisfy your custom-fields schema.
                      details[] lists field and issue.
                    instance: /api/entity/v1/entities
                    code: CUSTOM_FIELDS_INVALID
                    correlationId: 0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10
                    details:
                      - field: numberOfEmployees
                        issue: NOT_IN_OPTIONS
        '401':
          description: 未授权。UNAUTHORIZED：缺少或无效的访问令牌。
          content:
            application/problem+json:
              schema:
                type: object
                description: RFC 9457 问题详情（application/problem+json）。
                properties:
                  type:
                    type: string
                    examples:
                      - about:blank
                  title:
                    type: string
                    description: 问题简述。
                  status:
                    type: integer
                    description: HTTP状态码。
                  detail:
                    type: string
                    description: 易于理解的解释。
                  instance:
                    type: string
                    description: 请求路径。
                  code:
                    type: string
                    description: 稳定的机器可读错误代码。根据此值进行分支。
                  correlationId:
                    type: string
                    format: uuid
                    description: 请求标识符。联系客服时请提供此标识符。
                    examples:
                      - 0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10
                  details:
                    type: array
                    description: 出错字段（如适用）。
                    items:
                      type: object
                      properties:
                        field:
                          type: string
                          examples:
                            - numberOfEmployees
                        issue:
                          type: string
                          examples:
                            - NOT_IN_OPTIONS
              examples:
                Example 1 - UNAUTHORIZED:
                  value:
                    type: about:blank
                    title: Unauthorized
                    status: 401
                    detail: Missing or invalid access token.
                    instance: /api/entity/v1/entities
                    code: UNAUTHORIZED
                    correlationId: 0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10
                    details: []
        '409':
          description: 冲突。DUPLICATE_ENTITY：externalId，或文档的类型 + id 对，已存在于您的商户中。
          content:
            application/problem+json:
              schema:
                type: object
                description: RFC 9457 问题详情（application/problem+json）。
                properties:
                  type:
                    type: string
                    examples:
                      - about:blank
                  title:
                    type: string
                    description: 问题简述。
                  status:
                    type: integer
                    description: HTTP状态码。
                  detail:
                    type: string
                    description: 易于理解的解释。
                  instance:
                    type: string
                    description: 请求路径。
                  code:
                    type: string
                    description: 稳定的机器可读错误代码。根据此值进行分支。
                  correlationId:
                    type: string
                    format: uuid
                    description: 请求标识符。联系客服时请提供此标识符。
                    examples:
                      - 0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10
                  details:
                    type: array
                    description: 出错字段（如适用）。
                    items:
                      type: object
                      properties:
                        field:
                          type: string
                          examples:
                            - numberOfEmployees
                        issue:
                          type: string
                          examples:
                            - NOT_IN_OPTIONS
              examples:
                Example 1 - DUPLICATE_ENTITY:
                  value:
                    type: about:blank
                    title: Conflict
                    status: 409
                    detail: >-
                      externalId, or the pair type + id of a document, already
                      exists in your merchant.
                    instance: /api/entity/v1/entities
                    code: DUPLICATE_ENTITY
                    correlationId: 0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10
                    details: []
        '413':
          description: 有效载荷过大。PAYLOAD_TOO_LARGE：属性超过 64 KB。
          content:
            application/problem+json:
              schema:
                type: object
                description: RFC 9457 问题详情（application/problem+json）。
                properties:
                  type:
                    type: string
                    examples:
                      - about:blank
                  title:
                    type: string
                    description: 问题简述。
                  status:
                    type: integer
                    description: HTTP状态码。
                  detail:
                    type: string
                    description: 易于理解的解释。
                  instance:
                    type: string
                    description: 请求路径。
                  code:
                    type: string
                    description: 稳定的机器可读错误代码。根据此值进行分支。
                  correlationId:
                    type: string
                    format: uuid
                    description: 请求标识符。联系客服时请提供此标识符。
                    examples:
                      - 0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10
                  details:
                    type: array
                    description: 出错字段（如适用）。
                    items:
                      type: object
                      properties:
                        field:
                          type: string
                          examples:
                            - numberOfEmployees
                        issue:
                          type: string
                          examples:
                            - NOT_IN_OPTIONS
              examples:
                Example 1 - PAYLOAD_TOO_LARGE:
                  value:
                    type: about:blank
                    title: Payload too large
                    status: 413
                    detail: attributes exceeds 64 KB.
                    instance: /api/entity/v1/entities
                    code: PAYLOAD_TOO_LARGE
                    correlationId: 0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10
                    details: []
        '415':
          description: >-
            不支持的媒体类型。UNSUPPORTED_MEDIA_TYPE：请求的 Content-Type 不是 endpoint
            所期望的（application/json，或用于上传的 multipart/form-data）。
          content:
            application/problem+json:
              schema:
                type: object
                description: RFC 9457 问题详情（application/problem+json）。
                properties:
                  type:
                    type: string
                    examples:
                      - about:blank
                  title:
                    type: string
                    description: 问题简述。
                  status:
                    type: integer
                    description: HTTP状态码。
                  detail:
                    type: string
                    description: 易于理解的解释。
                  instance:
                    type: string
                    description: 请求路径。
                  code:
                    type: string
                    description: 稳定的机器可读错误代码。根据此值进行分支。
                  correlationId:
                    type: string
                    format: uuid
                    description: 请求标识符。联系客服时请提供此标识符。
                    examples:
                      - 0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10
                  details:
                    type: array
                    description: 出错字段（如适用）。
                    items:
                      type: object
                      properties:
                        field:
                          type: string
                          examples:
                            - numberOfEmployees
                        issue:
                          type: string
                          examples:
                            - NOT_IN_OPTIONS
              examples:
                Example 1 - UNSUPPORTED_MEDIA_TYPE:
                  value:
                    type: about:blank
                    title: Unsupported media type
                    status: 415
                    detail: >-
                      The request Content-Type is not the one the endpoint
                      expects (application/json, or multipart/form-data for
                      uploads).
                    instance: /api/entity/v1/entities
                    code: UNSUPPORTED_MEDIA_TYPE
                    correlationId: 0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10
                    details: []
        '422':
          description: >-
            无法处理的实体。INCOMPLETE_KYC_DATA：缺少最低 KYC 数据：INDIVIDUAL
            需提供姓名（name）和姓氏（lastname），COMPANY 需提供名称（name）。
          content:
            application/problem+json:
              schema:
                type: object
                description: RFC 9457 问题详情（application/problem+json）。
                properties:
                  type:
                    type: string
                    examples:
                      - about:blank
                  title:
                    type: string
                    description: 问题简述。
                  status:
                    type: integer
                    description: HTTP状态码。
                  detail:
                    type: string
                    description: 易于理解的解释。
                  instance:
                    type: string
                    description: 请求路径。
                  code:
                    type: string
                    description: 稳定的机器可读错误代码。根据此值进行分支。
                  correlationId:
                    type: string
                    format: uuid
                    description: 请求标识符。联系客服时请提供此标识符。
                    examples:
                      - 0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10
                  details:
                    type: array
                    description: 出错字段（如适用）。
                    items:
                      type: object
                      properties:
                        field:
                          type: string
                          examples:
                            - numberOfEmployees
                        issue:
                          type: string
                          examples:
                            - NOT_IN_OPTIONS
              examples:
                Example 1 - INCOMPLETE_KYC_DATA:
                  value:
                    type: about:blank
                    title: Unprocessable entity
                    status: 422
                    detail: >-
                      Minimum KYC data is missing: name and lastname for
                      INDIVIDUAL, name for COMPANY.
                    instance: /api/entity/v1/entities
                    code: INCOMPLETE_KYC_DATA
                    correlationId: 0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10
                    details: []
      security:
        - token: []
components:
  securitySchemes:
    token:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.