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/assinafy-com-br:assinafy-com-br-fields-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

openapi: 3.2.0
info:
  title: Assinafy Com Br Fields API
  version: 1.0.0
  description: 'Operations tagged Fields across 2 of this provider''s published API definitions: assinafy-com-br-openapi.json, assinafy-com-br-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.assinafy.com.br
  description: Production
- url: https://sandbox.assinafy.com.br
  description: Sandbox
tags:
- name: Fields
  description: Reusable field definitions used on templates and assignments.
paths:
  /v1/accounts/{accountId}/fields:
    get:
      tags:
      - Fields
      summary: List fields
      description: 'List the field definitions of a workspace.


        When `include_standard` is enabled, records of type `signature`, `initial` and `signatureDate` are also returned. Every workspace has one of each, created with it; they cannot be created, and a field can''t be placed on the `Editor` role with them.


        To find the fields a sender can place on a document or template, list with `include_standard=true`: the result is every active field definition, signature fields included, and each one''s `id` is the `field_id` to place.


        Copy as Markdown Open in ChatGPT Open in Claude'
      operationId: fd984179bd5458646412b752c5510248
      parameters:
      - $ref: '#/components/parameters/AccountId'
      - name: include_inactive
        in: query
        description: Include inactive field definitions.
        schema:
          type: boolean
      - name: include_standard
        in: query
        description: Include standard field types (signature, initial, signatureDate).
        schema:
          type: boolean
      responses:
        '200':
          description: Field definitions
          content:
            application/json:
              schema:
                type: object
                allOf:
                - $ref: '#/components/schemas/Envelope'
                - properties:
                    data:
                      type: array
                      items:
                        $ref: '#/components/schemas/Field'
                  type: object
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/ServerError'
      security:
      - bearerAuth: []
      - apiKeyAuth: []
    post:
      tags:
      - Fields
      summary: Create field
      description: 'Create a field definition in the workspace.


        Copy as Markdown Open in ChatGPT Open in Claude'
      operationId: 73c2101959ae1a1fd07882ab7d869721
      parameters:
      - $ref: '#/components/parameters/AccountId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - name
              - type
              properties:
                name:
                  type: string
                  example: Full name
                type:
                  type: string
                  example: text
                regex:
                  type:
                  - string
                  - 'null'
                is_required:
                  type: boolean
              type: object
      responses:
        '200':
          description: The created field
          content:
            application/json:
              schema:
                type: object
                allOf:
                - $ref: '#/components/schemas/Envelope'
                - properties:
                    data:
                      $ref: '#/components/schemas/Field'
                  type: object
        '400':
          $ref: '#/components/responses/ValidationError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/ServerError'
      security:
      - bearerAuth: []
      - apiKeyAuth: []
    servers:
    - url: https://api.assinafy.com.br
      description: Production
    - url: https://sandbox.assinafy.com.br
      description: Sandbox
  /v1/accounts/{accountId}/fields/{fieldId}:
    get:
      tags:
      - Fields
      summary: Get field
      description: 'Retrieve a single field definition.


        Copy as Markdown Open in ChatGPT Open in Claude'
      operationId: 8c103388d30ec655cb1a6acb2412fe91
      parameters:
      - $ref: '#/components/parameters/AccountId'
      - name: fieldId
        in: path
        description: The field ID.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The field
          content:
            application/json:
              schema:
                type: object
                allOf:
                - $ref: '#/components/schemas/Envelope'
                - properties:
                    data:
                      $ref: '#/components/schemas/Field'
                  type: object
        '404':
          $ref: '#/components/responses/NotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/ServerError'
      security:
      - bearerAuth: []
      - apiKeyAuth: []
    put:
      tags:
      - Fields
      summary: Update field
      description: 'Update a field definition.


        Copy as Markdown Open in ChatGPT Open in Claude'
      operationId: 815e25604c39fceca60c2fb160bac50b
      parameters:
      - $ref: '#/components/parameters/AccountId'
      - name: fieldId
        in: path
        description: The field ID.
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                name:
                  type: string
                regex:
                  type:
                  - string
                  - 'null'
                is_active:
                  type: boolean
              type: object
      responses:
        '200':
          description: The updated field
          content:
            application/json:
              schema:
                type: object
                allOf:
                - $ref: '#/components/schemas/Envelope'
                - properties:
                    data:
                      $ref: '#/components/schemas/Field'
                  type: object
        '404':
          $ref: '#/components/responses/NotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/ServerError'
      security:
      - bearerAuth: []
      - apiKeyAuth: []
    delete:
      tags:
      - Fields
      summary: Delete field
      description: 'Delete a field definition.


        Copy as Markdown Open in ChatGPT Open in Claude'
      operationId: 429ef4a2c141164d4f64019cf7940e31
      parameters:
      - $ref: '#/components/parameters/AccountId'
      - name: fieldId
        in: path
        description: The field ID.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Field deleted
          content:
            application/json:
              schema:
                type: object
                allOf:
                - $ref: '#/components/schemas/Envelope'
                - properties:
                    data:
                      type: array
                      items: []
                      example: []
                  type: object
        '404':
          $ref: '#/components/responses/NotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/ServerError'
      security:
      - bearerAuth: []
      - apiKeyAuth: []
    servers:
    - url: https://api.assinafy.com.br
      description: Production
    - url: https://sandbox.assinafy.com.br
      description: Sandbox
  /v1/accounts/{accountId}/fields/{fieldId}/validate:
    post:
      tags:
      - Fields
      summary: Validate field value
      description: 'Validate an input value against a field definition. Typically called with a signer access code during the signing flow.


        Copy as Markdown Open in ChatGPT Open in Claude'
      operationId: 5b256c974f65070abdbc89f9a35406d1
      parameters:
      - $ref: '#/components/parameters/AccountId'
      - name: fieldId
        in: path
        description: The field ID.
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  description: The input value to validate.
                  example: 400.676.228-36
              type: object
      responses:
        '200':
          description: Validation result
          content:
            application/json:
              schema:
                type: object
                allOf:
                - $ref: '#/components/schemas/Envelope'
                - properties:
                    data:
                      $ref: '#/components/schemas/FieldValidation'
                  type: object
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/ServerError'
      security:
      - bearerAuth: []
      - apiKeyAuth: []
    servers:
    - url: https://api.assinafy.com.br
      description: Production
    - url: https://sandbox.assinafy.com.br
      description: Sandbox
  /v1/accounts/{accountId}/fields/validate-multiple:
    post:
      tags:
      - Fields
      summary: Validate multiple field values
      description: 'Validate multiple input values at once. The request body is a JSON array of `{field_id, value}` objects.


        Copy as Markdown Open in ChatGPT Open in Claude'
      operationId: 94ff510ce5cb7321bfdb7e1de3bfd92a
      parameters:
      - $ref: '#/components/parameters/AccountId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                required:
                - field_id
                - value
                properties:
                  field_id:
                    description: The field definition ID.
                    type: string
                    example: 63488ffb7adf435aba319787
                  value:
                    description: The input value to validate.
                    example: '1111111111111'
                type: object
      responses:
        '200':
          description: Validation results
          content:
            application/json:
              schema:
                type: object
                allOf:
                - $ref: '#/components/schemas/Envelope'
                - properties:
                    data:
                      type: array
                      items:
                        $ref: '#/components/schemas/FieldValidationResult'
                  type: object
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/ServerError'
      security:
      - bearerAuth: []
      - apiKeyAuth: []
    servers:
    - url: https://api.assinafy.com.br
      description: Production
    - url: https://sandbox.assinafy.com.br
      description: Sandbox
  /v1/field-types:
    get:
      tags:
      - Fields
      summary: List field types
      description: 'List the types a workspace can create field definitions with (`POST /v1/accounts/{accountId}/fields`). The built-in `signature`, `initial` and `signatureDate` types are not listed: they can''t be created, and their definitions come from `GET /v1/accounts/{accountId}/fields?include_standard=true`. `cpf` expects 11 digits; `cnpj` accepts 14-char values (letters A-Z allowed in positions 1–12 per the CNPJ Alfanumérico rule; check digits 13–14 stay numeric). Punctuation is ignored during validation.


        Copy as Markdown Open in ChatGPT Open in Claude'
      operationId: f6ac99a60d22a08e8f58568c50d904d8
      responses:
        '200':
          description: Field types
          content:
            application/json:
              schema:
                type: object
                allOf:
                - $ref: '#/components/schemas/Envelope'
                - properties:
                    data:
                      type: array
                      items:
                        $ref: '#/components/schemas/FieldType'
                  type: object
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/ServerError'
      security:
      - bearerAuth: []
      - apiKeyAuth: []
    servers:
    - url: https://api.assinafy.com.br
      description: Production
    - url: https://sandbox.assinafy.com.br
      description: Sandbox
components:
  responses:
    NotFound:
      description: The requested resource does not exist.
      content:
        application/json:
          schema:
            type: object
            allOf:
            - $ref: '#/components/schemas/ErrorEnvelope'
            - properties:
                status:
                  type: integer
                  example: 404
                message:
                  type: string
                  example: The requested resource was not found.
              type: object
    ValidationError:
      description: One or more fields failed validation.
      content:
        application/json:
          schema:
            type: object
            allOf:
            - $ref: '#/components/schemas/ErrorEnvelope'
            - properties:
                status:
                  type: integer
                  example: 422
                message:
                  type: string
                  example: One or more fields failed validation.
              type: object
    Unauthorized:
      description: Missing or invalid credentials.
      content:
        application/json:
          schema:
            type: object
            allOf:
            - $ref: '#/components/schemas/ErrorEnvelope'
            - properties:
                status:
                  type: integer
                  example: 401
                message:
                  type: string
                  example: Your request was made with invalid credentials.
              type: object
    ServerError:
      description: Unexpected server error.
      content:
        application/json:
          schema:
            type: object
            allOf:
            - $ref: '#/components/schemas/ErrorEnvelope'
            - properties:
                status:
                  type: integer
                  example: 500
                message:
                  type: string
                  example: An unexpected error occurred.
              type: object
  schemas:
    FieldValidationResult:
      description: A per-field result from a multi-field validation.
      properties:
        field_id:
          type: string
          example: 63488ffb7adf435aba319787
        type:
          type: string
          example: cpf
        success:
          type: boolean
          example: false
        error_message:
          type: string
          example: Invalid CPF.
      type: object
    FieldValidation:
      description: The result of validating a value against a field definition.
      properties:
        type:
          description: The field's validation type.
          type: string
          example: cpf
        success:
          type: boolean
          example: true
        error_message:
          description: Empty when valid.
          type: string
          example: ''
      type: object
    Field:
      description: A reusable field definition.
      properties:
        resource:
          type: string
          example: field
        id:
          type: string
          example: 6152120297080d55bdd13197
        name:
          type: string
          example: Signature
        type:
          type: string
          example: signature
        regex:
          type:
          - string
          - 'null'
        is_pre_defined:
          type: boolean
        is_active:
          type: boolean
        is_required:
          type: boolean
        is_standard:
          type: boolean
        is_read_only:
          type: boolean
        is_visible:
          type: boolean
      type: object
    FieldType:
      description: A supported field/validation type.
      properties:
        type:
          type: string
          example: cpf
        name:
          type: string
          example: CPF
      type: object
    Envelope:
      description: Standard success wrapper. Operations add their own `data`.
      properties:
        status:
          description: HTTP status code, mirrored in the body.
          type: integer
          example: 200
        message:
          description: Human-readable message; empty on success.
          type: string
          example: ''
      type: object
    ErrorEnvelope:
      description: Standard error wrapper. `status` mirrors the HTTP status code.
      properties:
        status:
          type: integer
          example: 400
        message:
          description: Human-readable error message.
          type: string
          example: Bad request.
        data:
          type:
          - object
          - 'null'
          example: null
      type: object
  parameters:
    AccountId:
      name: accountId
      in: path
      description: Workspace account ID.
      required: true
      schema:
        type: string
  securitySchemes:
    bearerAuth:
      type: http
      description: 'Access token: `Authorization: Bearer {access_token}`.'
      bearerFormat: JWT
      scheme: bearer
    apiKeyAuth:
      type: apiKey
      description: Permanent API key (recommended for back-end integrations).
      name: X-Api-Key
      in: header
    signerAccessCode:
      type: apiKey
      description: 'Signer access code used by signer-facing (Signing) endpoints instead of a user token: the code in the signer''s signing link, sent as the `signer-access-code` query or body parameter. It can be used again and has no expiry; it stops working when the signing request is removed. Treat it as a secret.'
      name: signer-access-code
      in: query
    oauth2:
      type: oauth2
      description: 'OAuth 2.1 authorization code flow with mandatory PKCE (S256), for applications and AI assistants acting in a user''s workspace with that user''s permission — as opposed to `apiKeyAuth`/`bearerAuth`, which authenticate the workspace or user directly. A token carries only the scopes the user approved and works for one workspace. Endpoints are published by the authorization server at `https://auth.assinafy.com.br/.well-known/oauth-authorization-server`. An OAuth token cannot reach billing, account lifecycle, credential management or admin surfaces regardless of scope. A missing scope answers `403` with `WWW-Authenticate: Bearer error="insufficient_scope"` naming it. See **OAuth Integration Guide** for the full flow.'
      flows:
        authorizationCode:
          authorizationUrl: https://auth.assinafy.com.br/oauth/authorize
          tokenUrl: https://api.assinafy.com.br/v1/oauth/token
          refreshUrl: https://api.assinafy.com.br/v1/oauth/token
          scopes:
            documents:read: Read documents, their pages, tags, signers, assignments and activity, and the WhatsApp notifications sent for an assignment.
            documents:write: Create, update and delete documents, and manage their signers, assignments and activity.
            templates:read: Read reusable document templates, their pages, roles, fields and tags.
            templates:write: Create, update and delete templates, their pages, roles, fields and tags.
            account:read: Read the workspace's profile, theme and logo.
            webhooks:write: Change the workspace's webhook subscription (delivery URL, events, contact email), deactivate it, manage webhook endpoints and re-send a delivery.
            openid: Identify the authenticated user (OpenID Connect `sub` claim) and enable the `/v1/oauth/userinfo` endpoint.
            profile: Include the user's name in the `id_token`/userinfo claims.
            email: Include the user's email and its verification status in the `id_token`/userinfo claims.
            offline_access: Request a refresh token, so the app keeps working after the user's session expires without prompting them again. Only granted to a client that explicitly asks for it.
x-refined-from:
- assinafy-com-br-openapi.json
- assinafy-com-br-openapi.json