Clarafintech

Clarafintech Users API

Create, update, retrieve, delete, and filter users by identity, role, status, manager, or location.

GitHub OpenAPI

Operations 5

GET /api/v3/users List users #
POST /api/v3/users Create a user #
GET /api/v3/users/{uuid} Get a user #
PATCH /api/v3/users/{uuid} Update a user #
DELETE /api/v3/users/{uuid} Delete a user #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/clarafintech/refs/heads/main/openapi/clarafintech-users-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/clarafintech/refs/heads/main/json-schema/clarafintech-pix-payment-v3-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/clarafintech/refs/heads/main/json-schema/clarafintech-transaction-v3-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/clarafintech/refs/heads/main/json-schema/clarafintech-reimbursement-v3-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/clarafintech/refs/heads/main/json-schema/clarafintech-update-user-request-v3-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/clarafintech/refs/heads/main/json-schema/clarafintech-card-v3-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/clarafintech/refs/heads/main/json-schema/clarafintech-create-pix-payment-request-v3-schema.json

Work with this as data

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

MCP server

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

https://apis.io/mcp

Tools for apis

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

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/clarafintech:clarafintech-users-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

clarafintech-users-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Clara Users API
  summary: Corporate card and spend management API for Mexico, Brazil, and Colombia.
  description: Use the Clara API to manage corporate cards, retrieve transactions, provision users, reconcile billing statements, download transaction documents, and automate spend-management workflows. Every API request requires both mutual TLS and an OAuth 2.0 Bearer token. This docs-published schema is derived from the current Clara developer documentation and should be checked against backend-owned API contracts before being treated as exhaustive.
  version: 3.0.0
  contact:
    name: Clara Integration Support
    email: integration.support.mx@clara.team
    url: https://developers.clara.team
servers:
- url: https://public-api.mx.clara.com
  description: Mexico production
- url: https://public-api.br.clara.com
  description: Brazil production
- url: https://public-api.co.clara.com
  description: Colombia production
- url: https://public-api.mx.clara.com/api-test
  description: Mexico sandbox. Use the same paths without the leading /api segment when testing, for example /v3/transactions.
- url: https://public-api.br.clara.com/api-test
  description: Brazil sandbox. Use the same paths without the leading /api segment when testing, for example /v3/transactions.
- url: https://public-api.co.clara.com/api-test
  description: Colombia sandbox. Use the same paths without the leading /api segment when testing, for example /v3/transactions.
security:
- MutualTLS: []
  BearerAuth: []
tags:
- name: Users
  description: Create, update, retrieve, delete, and filter users by identity, role, status, manager, or location.
paths:
  /api/v3/users:
    get:
      operationId: listUsersV3
      summary: List users
      description: List Clara users with filters for identity, role, status, tax identifier, ERP ID, location, manager, or creation date.
      tags:
      - Users
      parameters:
      - $ref: '#/components/parameters/Page'
      - $ref: '#/components/parameters/Size'
      - name: email
        in: query
        description: Filter by email address.
        schema:
          type: string
          format: email
      - name: fullName
        in: query
        description: Filter by full name.
        schema:
          type: string
      - name: uuid
        in: query
        description: Filter by user UUID.
        schema:
          type: string
          format: uuid
      - name: name
        in: query
        description: Filter by first name.
        schema:
          type: string
      - name: lastName
        in: query
        description: Filter by last name.
        schema:
          type: string
      - name: mobilePhone
        in: query
        description: Filter by mobile phone number.
        schema:
          type: string
      - name: taxIdentifier
        in: query
        description: Filter by tax identifier.
        schema:
          type: string
      - name: erpId
        in: query
        description: Filter by ERP identifier.
        schema:
          type: string
      - name: createdAtStart
        in: query
        description: Filter users created on or after this date.
        schema:
          type: string
          format: date
      - name: createdAtEnd
        in: query
        description: Filter users created on or before this date.
        schema:
          type: string
          format: date
      - name: locationUuid
        in: query
        description: Filter by location UUID.
        schema:
          type: string
          format: uuid
      - name: locationName
        in: query
        description: Filter by location name.
        schema:
          type: string
      - name: managerUuid
        in: query
        description: Filter by manager UUID.
        schema:
          type: string
          format: uuid
      - name: status
        in: query
        description: Filter by user status.
        schema:
          $ref: '#/components/schemas/UserStatus'
      - name: role
        in: query
        description: Filter by Clara user role.
        schema:
          $ref: '#/components/schemas/UserRole'
      responses:
        '200':
          description: Paginated users.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserPageV3'
    post:
      operationId: createUserV3
      summary: Create a user
      description: Create a user in the company account. Non-company-owner users generally require group and location assignment, and tax identifier length depends on country.
      tags:
      - Users
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateUserRequestV3'
      responses:
        '201':
          description: User created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateUserResponseV3'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '422':
          $ref: '#/components/responses/BusinessValidation'
  /api/v3/users/{uuid}:
    get:
      operationId: getUserV3
      summary: Get a user
      description: Retrieve a single user by UUID.
      tags:
      - Users
      parameters:
      - $ref: '#/components/parameters/UserUuid'
      responses:
        '200':
          description: User details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserV3'
        '404':
          $ref: '#/components/responses/NotFound'
    patch:
      operationId: updateUserV3
      summary: Update a user
      description: Update user profile, role, hierarchy, location, ERP, tax, or group membership fields. When cleanGroups is true, groupsToAdd must leave the user with at least one group.
      tags:
      - Users
      parameters:
      - $ref: '#/components/parameters/UserUuid'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateUserRequestV3'
      responses:
        '200':
          description: User updated.
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/BusinessValidation'
    delete:
      operationId: deleteUserV3
      summary: Delete a user
      description: Delete a user by UUID.
      tags:
      - Users
      parameters:
      - $ref: '#/components/parameters/UserUuid'
      responses:
        '204':
          description: User deleted.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    UserV3:
      type: object
      properties:
        uuid:
          type: string
          format: uuid
        fullName:
          type: string
        name:
          type: string
        lastName:
          type: string
        email:
          type: string
          format: email
        mobilePhone:
          type: string
        taxIdentifier:
          type: string
        role:
          $ref: '#/components/schemas/UserRole'
        status:
          oneOf:
          - $ref: '#/components/schemas/UserStatus'
          - $ref: '#/components/schemas/StatusObject'
        erpId:
          type: string
        createdAt:
          type: string
          format: date-time
        groups:
          type: array
          items:
            $ref: '#/components/schemas/LinkedResource'
        cards:
          type: array
          items:
            $ref: '#/components/schemas/CardV3'
        manager:
          $ref: '#/components/schemas/CardUser'
        location:
          $ref: '#/components/schemas/LinkedResource'
      additionalProperties: true
    ErrorResponse:
      type: object
      required:
      - message
      properties:
        code:
          type: string
          description: Machine-readable Clara or HTTP error code when available.
        message:
          type: string
          description: Human-readable error message.
        timestamp:
          type: string
          format: date-time
        details:
          type: array
          items:
            type: object
            additionalProperties: true
      additionalProperties: true
    LinkedResource:
      type: object
      properties:
        uuid:
          type: string
          format: uuid
        name:
          type: string
        links:
          type: array
          items:
            type: object
            additionalProperties: true
        _links:
          type: object
          additionalProperties: true
      additionalProperties: true
    UserRole:
      type: string
      enum:
      - EMPLOYEE
      - MANAGER
      - COMPANY_OWNER
      - BOOKKEEPER
    UserStatus:
      type: string
      enum:
      - ONBOARDING_CANDIDATE
      - WAITING
      - DELETED
      - ACTIVE
      - LOCKED
      - INACTIVE
      - PENDING
      - MASTER_LOCKED
      - CLARA_BLOCKED
    StatusObject:
      type: object
      properties:
        code:
          type: string
        description:
          type: string
      additionalProperties: true
    UpdateUserRequestV3:
      type: object
      properties:
        email:
          type: string
          format: email
        name:
          type: string
        lastName:
          type: string
        lada:
          type: string
          description: Must be provided together with mobilePhone when changing phone fields.
        mobilePhone:
          type: string
          description: Must be provided together with lada when changing phone fields.
        role:
          $ref: '#/components/schemas/UserRole'
        locationUuid:
          type: string
          format: uuid
        erpId:
          type: string
        taxIdentifier:
          type: string
          description: 'Tax identifier. Documented country lengths: MX 11 or 13, CO 7-10, BR 11.'
        managerUuid:
          type: string
          format: uuid
        groupsToAdd:
          type: array
          items:
            type: string
            format: uuid
        groupsToRemove:
          type: array
          items:
            type: string
            format: uuid
        cleanGroups:
          type: boolean
          default: false
      additionalProperties: false
    CardUser:
      type: object
      properties:
        uuid:
          type: string
          format: uuid
        name:
          type: string
        fullName:
          type: string
        username:
          type: string
        email:
          type: string
          format: email
      additionalProperties: true
    UserPageV3:
      type: object
      required:
      - content
      - totalElements
      properties:
        content:
          type: array
          items:
            $ref: '#/components/schemas/UserV3'
        totalElements:
          type: integer
        totalPages:
          type: integer
        size:
          type: integer
        number:
          type: integer
    CardListType:
      type: string
      enum:
      - MASTER_WORLD_ELITE
      - MASTER_CORPORATE
      - MASTER_VIRTUAL
      - VISA_PHYSICAL
      - VISA_VIRTUAL
    CreateUserRequestV3:
      type: object
      required:
      - email
      - name
      - lastName
      - mobilePhone
      - role
      properties:
        email:
          type: string
          format: email
        name:
          type: string
        lastName:
          type: string
        groups:
          type: array
          items:
            type: string
            format: uuid
        lada:
          type: string
        mobilePhone:
          type: string
        role:
          $ref: '#/components/schemas/UserRole'
        managerUuid:
          type: string
          format: uuid
        locationUuid:
          type: string
          format: uuid
        erpId:
          type: string
        taxIdentifier:
          type: string
          description: 'Tax identifier. Documented country lengths: MX 11 or 13, CO 7-10, BR 11.'
        foreign:
          type: boolean
          default: false
      additionalProperties: false
    Periodicity:
      type: string
      enum:
      - DAILY
      - WEEKLY
      - MONTHLY
    CreateUserResponseV3:
      type: object
      required:
      - uuid
      properties:
        uuid:
          type: string
          format: uuid
      additionalProperties: true
    CardV3:
      type: object
      required:
      - uuid
      - alias
      - status
      - maskedPan
      - type
      properties:
        uuid:
          type: string
          format: uuid
        alias:
          type: string
        status:
          oneOf:
          - type: string
          - $ref: '#/components/schemas/StatusObject'
        claraStatus:
          type: string
          deprecated: true
          description: Deprecated as of May 2025. Use status instead.
        lockCode:
          type:
          - string
          - integer
          - 'null'
        maskedPan:
          type: string
        threshold:
          type: number
        periodicity:
          oneOf:
          - $ref: '#/components/schemas/Periodicity'
          - type: object
            properties:
              type:
                $ref: '#/components/schemas/Periodicity'
            additionalProperties: true
        type:
          oneOf:
          - $ref: '#/components/schemas/CardListType'
          - type: object
            additionalProperties: true
        user:
          $ref: '#/components/schemas/CardUser'
      additionalProperties: true
  responses:
    Unauthorized:
      description: Unauthorized. Refresh the token or verify mTLS certificate configuration.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Forbidden:
      description: Forbidden. The token is valid but lacks permission for this resource.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    NotFound:
      description: Resource not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    BusinessValidation:
      description: Business validation error. The request is well formed but violates a Clara business rule.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    BadRequest:
      description: Bad request. Fix invalid parameters or missing fields before retrying.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  parameters:
    UserUuid:
      name: uuid
      in: path
      required: true
      description: User UUID.
      schema:
        type: string
        format: uuid
    Size:
      name: size
      in: query
      description: Number of records per page. Use 100 for large exports unless an endpoint documents a lower limit.
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 20
    Page:
      name: page
      in: query
      description: Zero-based page index.
      schema:
        type: integer
        minimum: 0
        default: 0
  securitySchemes:
    MutualTLS:
      type: mutualTLS
      description: All API requests require a valid Clara-issued X.509 client certificate.
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: OAuth 2.0 Bearer token from /oauth/token.
    BasicAuth:
      type: http
      scheme: basic
      description: Use CLIENT_ID:CLIENT_SECRET when requesting an access token.
externalDocs:
  description: Clara API documentation
  url: https://developers.clara.team
x-source: Derived from the developers.clara.team documentation in this repository. Replace with the backend-owned OpenAPI contract if one is available.