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-signers-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 Signers API
  version: 1.0.0
  description: 'Operations tagged Signers 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: Signers
  description: Manage the signing parties of a workspace.
paths:
  /v1/accounts/{accountId}/signers:
    get:
      tags:
      - Signers
      summary: List signers
      description: 'List the signers of a workspace.


        Copy as Markdown Open in ChatGPT Open in Claude'
      operationId: 80ef05854b7106b70f9f5bf6095f2225
      parameters:
      - $ref: '#/components/parameters/AccountId'
      - name: search
        in: query
        description: Filter by full_name or email.
        schema:
          type: string
      - $ref: '#/components/parameters/Page'
      - $ref: '#/components/parameters/PerPage'
      responses:
        '200':
          description: A page of signers
          content:
            application/json:
              schema:
                type: object
                allOf:
                - $ref: '#/components/schemas/Envelope'
                - properties:
                    data:
                      type: array
                      items:
                        $ref: '#/components/schemas/Signer'
                  type: object
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/ServerError'
      security:
      - bearerAuth: []
      - apiKeyAuth: []
    post:
      tags:
      - Signers
      summary: Create signer
      description: 'Create a signer in the workspace.


        Copy as Markdown Open in ChatGPT Open in Claude'
      operationId: 9b3709e1ace146e1615e4d29ce845d67
      parameters:
      - $ref: '#/components/parameters/AccountId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - full_name
              properties:
                full_name:
                  type: string
                  example: John Dove
                email:
                  type: string
                  format: email
                  example: john@example.com
                whatsapp_phone_number:
                  description: E.164; normalized on save.
                  type: string
                  example: '+5548999990000'
                government_id:
                  description: Signer's CPF (11 digits) or CNPJ (14 characters; may be alphanumeric). Formatting is accepted and the value is normalized on save. Required before the signer can use a verification method that identifies them by CPF.
                  type: string
                  example: 390.533.447-05
              type: object
      responses:
        '200':
          description: The created signer
          content:
            application/json:
              schema:
                type: object
                allOf:
                - $ref: '#/components/schemas/Envelope'
                - properties:
                    data:
                      $ref: '#/components/schemas/Signer'
                  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}/signers/{signerId}:
    get:
      tags:
      - Signers
      summary: Get signer
      description: 'Retrieve a signer''s information.


        Copy as Markdown Open in ChatGPT Open in Claude'
      operationId: cfea1006df2f682a6e9c1ec8563d5d37
      parameters:
      - $ref: '#/components/parameters/AccountId'
      - name: signerId
        in: path
        description: The signer ID.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The signer
          content:
            application/json:
              schema:
                type: object
                allOf:
                - $ref: '#/components/schemas/Envelope'
                - properties:
                    data:
                      $ref: '#/components/schemas/Signer'
                  type: object
        '404':
          $ref: '#/components/responses/NotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/ServerError'
      security:
      - bearerAuth: []
      - apiKeyAuth: []
    put:
      tags:
      - Signers
      summary: Update signer
      description: 'Update a signer''s information. Only the fields sent change; send just the ones you are changing.


        **Clearing a field:** `null` or `"` clears `email`, `whatsapp_phone_number` and `government_id` (`whatsapp_phone_number` is stored as `null` either way; the other two keep the value sent). `full_name` cannot be cleared.


        **Verification integrity:** `email` / `whatsapp_phone_number` cannot be changed while the signer has verified that channel on an in-flight (not yet certificated) document — the response is `400` naming the offending document(s). Already-certificated documents do not block updates. Changing a channel that has *unverified* in-flight requests rotates their access/verification codes (invalidating previously sent links/OTPs); use the resend endpoint to redeliver. `full_name` can always be updated.


        Copy as Markdown Open in ChatGPT Open in Claude'
      operationId: 8b29918a9706391427301103b2a7551e
      parameters:
      - $ref: '#/components/parameters/AccountId'
      - name: signerId
        in: path
        description: The signer ID.
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                full_name:
                  type: string
                  example: John Dove
                email:
                  description: Can't be changed or cleared while the signer has verified it on an in-flight document (`400`).
                  type: string
                  format: email
                  example: john@example.com
                whatsapp_phone_number:
                  description: E.164; normalized on save, and compared after normalizing, so the same number in another format is not a change. Can't be changed or cleared while the signer has verified it on an in-flight document (`400`).
                  type: string
                  example: '+5548999990000'
                government_id:
                  description: Signer's CPF (11 digits) or CNPJ (14 characters; may be alphanumeric). Formatting is accepted and the value is normalized on save.
                  type: string
                  example: 390.533.447-05
              type: object
      responses:
        '200':
          description: The updated signer
          content:
            application/json:
              schema:
                type: object
                allOf:
                - $ref: '#/components/schemas/Envelope'
                - properties:
                    data:
                      $ref: '#/components/schemas/Signer'
                  type: object
        '400':
          $ref: '#/components/responses/ValidationError'
        '404':
          $ref: '#/components/responses/NotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/ServerError'
      security:
      - bearerAuth: []
      - apiKeyAuth: []
    delete:
      tags:
      - Signers
      summary: Delete signer
      description: 'Delete a signer.


        Copy as Markdown Open in ChatGPT Open in Claude'
      operationId: bbe6808f264165e6752b911a5bce9c3e
      parameters:
      - $ref: '#/components/parameters/AccountId'
      - name: signerId
        in: path
        description: The signer ID.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Signer 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
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
    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
    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
    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
  parameters:
    AccountId:
      name: accountId
      in: path
      description: Workspace account ID.
      required: true
      schema:
        type: string
    PerPage:
      name: per-page
      in: query
      description: Records per page (max 100).
      schema:
        type: integer
        maximum: 100
        example: 25
    Page:
      name: page
      in: query
      description: Page number.
      schema:
        type: integer
        minimum: 1
        example: 1
  schemas:
    Signer:
      description: A signing party belonging to a workspace account.
      properties:
        resource:
          description: Present in single-resource responses.
          type: string
          example: signer
        id:
          type: string
          example: 62d6ee35c7741ca4006b9e11
        full_name:
          type: string
          example: John Signer
        email:
          type:
          - string
          - 'null'
          format: email
          example: john@example.com
        whatsapp_phone_number:
          description: E.164 format; normalized on save.
          type:
          - string
          - 'null'
          example: '+5548999990000'
        government_id:
          description: Signer's normalized CPF (11 digits) or CNPJ (14 characters; may be alphanumeric).
          type:
          - string
          - 'null'
          example: '39053344705'
        has_accepted_terms:
          type: boolean
          example: false
      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
  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