Assinafy Accounts API

openapi: 3.2.0
info:
  title: Assinafy Com Br Accounts API
  version: 1.0.0
  description: 'Operations tagged Accounts 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: Accounts
  description: 'Workspace accounts: profile, logo and theme.'
paths:
  /v1/accounts/{accountId}:
    get:
      tags:
      - Accounts
      summary: Get account
      description: 'Retrieve a workspace account the user belongs to.


        Copy as Markdown Open in ChatGPT Open in Claude'
      operationId: 3afeb0e00a024f92298a557cf8475184
      parameters:
      - $ref: '#/components/parameters/AccountId'
      responses:
        '200':
          description: The account
          content:
            application/json:
              schema:
                type: object
                allOf:
                - $ref: '#/components/schemas/Envelope'
                - properties:
                    data:
                      $ref: '#/components/schemas/Account'
                  type: object
        '404':
          $ref: '#/components/responses/NotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/ServerError'
      security:
      - bearerAuth: []
      - apiKeyAuth: []
    put:
      tags:
      - Accounts
      summary: Update account
      description: 'Update a workspace account''s profile.


        Copy as Markdown Open in ChatGPT Open in Claude'
      operationId: 65686705e7f9e91c3351341bbf7a1817
      parameters:
      - $ref: '#/components/parameters/AccountId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                name:
                  type: string
                  example: Acme Inc.
                notification_sender_type:
                  description: Who signers see as the notification sender for documents in this account. `User` (default) shows the document owner's name; `Account` shows this account's name.
                  type: string
                  enum:
                  - User
                  - Account
                  example: Account
              type: object
      responses:
        '200':
          description: The updated account
          content:
            application/json:
              schema:
                type: object
                allOf:
                - $ref: '#/components/schemas/Envelope'
                - properties:
                    data:
                      $ref: '#/components/schemas/Account'
                  type: object
        '400':
          $ref: '#/components/responses/ValidationError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/ServerError'
      security:
      - bearerAuth: []
      - apiKeyAuth: []
    delete:
      tags:
      - Accounts
      summary: Delete account
      description: 'Delete a workspace account.


        By default the request fails with `400` when the workspace has an active paid subscription — the `restrictions` array in the response lists each blocker by code so you can address them individually before retrying. Pass `force: true` to cancel any active paid subscription automatically and proceed with immediate deletion.


        Copy as Markdown Open in ChatGPT Open in Claude'
      operationId: 1aa001f00400a7df2f7f5ddefc3f3321
      parameters:
      - $ref: '#/components/parameters/AccountId'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                force:
                  description: When `true`, cancels any active paid subscription on this workspace and proceeds with deletion immediately. Defaults to `false`.
                  type: boolean
                  example: false
              type: object
      responses:
        '200':
          description: Account deleted
          content:
            application/json:
              schema:
                type: object
                allOf:
                - $ref: '#/components/schemas/Envelope'
                - properties:
                    data:
                      type: array
                      items: []
                      example: []
                  type: object
        '400':
          $ref: '#/components/responses/DeletionRestrictions'
        '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}/theme:
    get:
      tags:
      - Accounts
      summary: Get account theme
      description: 'Retrieve account theme information (branding name, colors, and logo URL).


        Copy as Markdown Open in ChatGPT Open in Claude'
      operationId: e769023db72349e5b478396ae92d12b2
      parameters:
      - $ref: '#/components/parameters/AccountId'
      responses:
        '200':
          description: The theme
          content:
            application/json:
              schema:
                type: object
                allOf:
                - $ref: '#/components/schemas/Envelope'
                - properties:
                    data:
                      $ref: '#/components/schemas/AccountTheme'
                  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}/logo:
    get:
      tags:
      - Accounts
      summary: Download account logo
      description: 'Download the account logo image binary.


        Copy as Markdown Open in ChatGPT Open in Claude'
      operationId: 216f1847ee6dbaa3fced4140fd2c2008
      parameters:
      - $ref: '#/components/parameters/AccountId'
      responses:
        '200':
          description: The logo image
          content:
            image/*:
              schema:
                type: string
                format: binary
        '404':
          $ref: '#/components/responses/NotFound'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/ServerError'
      security:
      - bearerAuth: []
      - apiKeyAuth: []
    post:
      tags:
      - Accounts
      summary: Upload account logo
      description: 'Upload or replace the account logo image.


        Copy as Markdown Open in ChatGPT Open in Claude'
      operationId: fbbd6967f8f20103e417fc1b0e4b7921
      parameters:
      - $ref: '#/components/parameters/AccountId'
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              required:
              - file
              properties:
                file:
                  type: string
                  format: binary
              type: object
      responses:
        '200':
          description: Logo updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Envelope'
        '400':
          $ref: '#/components/responses/ValidationError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/ServerError'
      security:
      - bearerAuth: []
      - apiKeyAuth: []
    delete:
      tags:
      - Accounts
      summary: Delete account logo
      description: 'Remove the account logo image.


        Copy as Markdown Open in ChatGPT Open in Claude'
      operationId: 0c8bf70659a47f7fb54e96de93697593
      parameters:
      - $ref: '#/components/parameters/AccountId'
      responses:
        '200':
          description: Logo deleted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Envelope'
        '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:
    get:
      tags:
      - Accounts
      summary: List my accounts
      description: 'List the workspace accounts the authenticated user belongs to.


        Called with an OAuth application token, this returns exactly one workspace: the one the user chose when they authorized the application. Use its `id` as the `{accountId}` segment of every other endpoint — a token is bound to a single workspace, and any request naming a different one is refused. This endpoint needs no particular scope.


        Copy as Markdown Open in ChatGPT Open in Claude'
      operationId: b66118db27c244ca018dd6cf1a9c7a8b
      responses:
        '200':
          description: The user's accounts
          content:
            application/json:
              schema:
                type: object
                allOf:
                - $ref: '#/components/schemas/Envelope'
                - properties:
                    data:
                      type: array
                      items:
                        $ref: '#/components/schemas/Account'
                  type: object
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/ServerError'
      security:
      - bearerAuth: []
      - apiKeyAuth: []
    post:
      tags:
      - Accounts
      summary: Create account
      description: 'Create a new workspace account owned by the authenticated user.


        Copy as Markdown Open in ChatGPT Open in Claude'
      operationId: 9b06ac45b842750e3be5df47e491531b
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - name
              properties:
                name:
                  type: string
                  example: Acme Inc.
                notification_sender_type:
                  description: Who signers see as the notification sender for documents in this account. `User` (default) shows the document owner's name; `Account` shows this account's name.
                  type: string
                  enum:
                  - User
                  - Account
                  example: Account
              type: object
      responses:
        '200':
          description: The created account
          content:
            application/json:
              schema:
                type: object
                allOf:
                - $ref: '#/components/schemas/Envelope'
                - properties:
                    data:
                      $ref: '#/components/schemas/Account'
                  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}/stats:
    get:
      tags:
      - Accounts
      summary: Account document KPIs
      description: 'Precomputed per-account document-funnel KPIs. `granularity=monthly` (default) returns the last 12 months, most recent first; `granularity=daily` with `month=YYYY-MM` returns that month''s days. Series are zero-filled. Requires the `account:read` OAuth scope.


        Copy as Markdown Open in ChatGPT Open in Claude'
      operationId: bd3114013a0533517d85f6e2fcbb1fe8
      parameters:
      - $ref: '#/components/parameters/AccountId'
      - name: granularity
        in: query
        description: '`monthly` (default) or `daily`.'
        schema:
          type: string
          enum:
          - monthly
          - daily
      - name: month
        in: query
        description: Target month `YYYY-MM` (required when `granularity=daily`).
        schema:
          type: string
          example: 2026-06
      responses:
        '200':
          description: KPI series
          content:
            application/json:
              schema:
                type: object
                allOf:
                - $ref: '#/components/schemas/Envelope'
                - properties:
                    data:
                      type: array
                      items:
                        $ref: '#/components/schemas/DocumentStatsRow'
                  type: object
        '400':
          $ref: '#/components/responses/ValidationError'
          description: Invalid month
        '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
    DeletionRestrictions:
      description: 'Deletion blocked by active restrictions. Each `restrictions` entry describes one blocker; resolve them individually, or retry with `force: true` to cancel blocking subscriptions/documents automatically.'
      content:
        application/json:
          schema:
            type: object
            allOf:
            - $ref: '#/components/schemas/ErrorEnvelope'
            - properties:
                status:
                  type: integer
                  example: 400
                message:
                  type: string
                  example: Cannot delete while restrictions are active.
                restrictions:
                  type: array
                  items:
                    properties:
                      code:
                        description: Machine-readable restriction code. `PendingDocuments` only appears together with `ActivePaidSubscription`, never alone.
                        type: string
                        enum:
                        - ActivePaidSubscription
                        - PendingDocuments
                        example: ActivePaidSubscription
                      message:
                        type: string
                        example: Account has an active paid subscription.
                      account_ids:
                        description: IDs of the accounts affected by this restriction.
                        type: array
                        items:
                          type: string
                        example:
                        - vmvk6Urzus3byLD2qO
                    type: object
              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:
    DocumentStatsRow:
      description: 'One period of the document-funnel KPI series. `period` is `YYYY-MM` (monthly) or `YYYY-MM-DD` (daily); series are zero-filled, no gaps. Signature requests come with two independent breakdowns: the `signature_requests_notification_*` counters split them by the channels the signer was notified on — a signer reached on more than one channel counts once per channel, so these add up to at least `signature_requests` — while the `signature_requests_verification_*` counters split them by how the signer''s identity is verified, and since each request has exactly one verification method those four always add up to `signature_requests`.'
      properties:
        period:
          description: '`YYYY-MM` (monthly) or `YYYY-MM-DD` (daily).'
          type: string
          example: 2026-06
        documents_uploaded:
          type: integer
          example: 42
        documents_sent:
          type: integer
          example: 37
        signature_requests:
          type: integer
          example: 61
        signature_requests_notification_email:
          description: Requests notified by e-mail.
          type: integer
          example: 55
        signature_requests_notification_whatsapp:
          description: Requests notified by WhatsApp.
          type: integer
          example: 18
        signature_requests_notification_bypass:
          description: Requests with no notification sent (`Bypass`).
          type: integer
          example: 3
        signature_requests_verification_email:
          description: Requests verified by an e-mail token.
          type: integer
          example: 48
        signature_requests_verification_whatsapp:
          description: Requests verified by a WhatsApp token.
          type: integer
          example: 6
        signature_requests_verification_bypass:
          description: Requests signed without token verification (`Bypass`).
          type: integer
          example: 3
        signature_requests_verification_digital_certificate:
          description: Requests signed with the signer's own ICP-Brasil digital certificate.
          type: integer
          example: 4
        signature_requests_viewed:
          description: Signature requests whose document was first viewed during the period.
          type: integer
          example: 44
        signature_requests_completed:
          description: Signature requests completed by individual signers during the period.
          type: integer
          example: 52
        documents_certified:
          type: integer
          example: 30
      type: object
    AccountTheme:
      description: An account's branding theme.
      properties:
        account_name:
          type: string
          example: Account Name
        primary_color:
          description: Hex color without leading `#`.
          type: string
          example: aabbcc
        secondary_color:
          type:
          - string
          - 'null'
          example: aabbcc
        logo:
          description: URL to the account logo.
          type: string
          example: https://api.assinafy.com.br/v1/accounts/1a/logo
      type: object
    Account:
      description: A workspace account (organization).
      properties:
        resource:
          type: string
          example: account
        id:
          type: string
          example: 6401df46d6a6b0c692d9ec49
        name:
          type: string
          example: Acme Inc.
        primary_color:
          type:
          - string
          - 'null'
          example: aabbcc
        secondary_color:
          type:
          - string
          - 'null'
          example: '112233'
        notification_sender_type:
          type: string
          enum:
          - User
          - Account
          example: User
        roles:
          type: array
          items:
            type: string
          example:
          - owner
        is_delete_allowed:
          type: boolean
          example: true
        limits:
          description: Limits of the workspace's current plan. Returned only by `GET /v1/accounts/{accountId}`, not in account lists. More keys may be added.
          properties:
            webhook_endpoints:
              description: 'How many webhook endpoints the workspace can have: `1`, or `3` with the Multiple Webhooks feature. Creating one past the limit returns `403`.'
              type: integer
              example: 1
          type: object
        created_at:
          type: string
          format: date-time
          example: '2026-06-03T03:54:16Z'
      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