eVerbary Embedded checkout API

The Embedded checkout API from eVerbary — 2 operation(s) for embedded checkout.

GitHub OpenAPI

Operations 2

POST /v1/checkout/sessions Open Session #
GET /v1/checkout/sessions/{session_id} Read Session #

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/everbary-com:everbary-com-embedded-checkout-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

everbary-com-embedded-checkout-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: eVerbary Order Embedded checkout API
  description: 'Place certified translation orders from your own software, follow them, and get

    the finished translation back.


    **Authentication.** Send your key as `Authorization: Bearer ` or

    `X-API-Key: `. Keys are issued from your eVerbary account (or by

    support@everbary.com). `GET /v1/me` tells you which account a key belongs to.


    **Test mode (sandbox).** A key that starts with `ev_test_` works on every

    endpoint below, but its orders are pretend: nothing is placed, charged, emailed

    or sent to a translator, and the documents you upload are checked and then

    discarded. Prices, languages and validation are the live ones, so what works in

    test works in live. A test order moves on its own - `new`, then `in-progress`

    after about a minute, then `completed` two minutes later with a sample

    translation and certificate attached - and each move is delivered to your

    webhook, signed exactly as in live. `POST /v1/sandbox/orders/{n}/advance`

    skips the wait; a `reference` or `note` containing `sandbox:cancel` makes the

    order end `cancelled`. Test orders are numbered from 900001 and kept 30 days.

    Responses for test orders carry `"sandbox": true`.


    **Webhooks.** `PUT /v1/webhook` registers one https URL per key and returns its

    signing secret once. Every delivery is a POST with `X-Everbary-Event` (e.g.

    `order.completed`) and `X-Everbary-Signature: t=,v1=`, an

    HMAC-SHA256 over `"."`. Verify it, and reject timestamps older than

    a few minutes. Failed deliveries are retried with a widening gap.


    **Embedded checkout.** For case-management software that wants a "Translate

    with eVerbary" button: `POST /v1/checkout/sessions` with the person, the case and

    the documents (signed links or base64) returns a `url` on orders.everbary.com.

    Send the person there: they choose languages and turnaround, see their

    account''s price, and place the order, paying now or later. An account is opened

    for them if they have none. The order''s webhook deliveries carry

    `checkoutSession`, `caseId` and your `metadata` back. Works with test keys

    (sandbox orders, no account opened). Try it: https://orders.everbary.com/checkout/demo


    **Idempotency.** Send `Idempotency-Key` with `POST /v1/orders`: a retried

    request returns the original order instead of placing a second one.


    Questions: support@everbary.com.'
  version: 1.1.0
tags:
- name: Embedded checkout
paths:
  /v1/checkout/sessions:
    post:
      tags:
      - Embedded checkout
      summary: Open Session
      description: 'Open an embedded checkout session and get the URL to send the person to.


        The files are fetched when the session is opened (signed links may expire

        a few minutes later) and their pages counted. The URL takes at most one

        order and stops working after 24 hours. Test keys open test sessions:

        the order is a sandbox order and no account is opened. Live sessions need

        a key with embedded checkout enabled.'
      operationId: open_session_v1_checkout_sessions_post
      parameters:
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      - name: x-api-key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Api-Key
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
              examples:
              - user:
                  email: paralegal@firm.com
                  first_name: Ana
                  last_name: Ruiz
                  firm: Ruiz Immigration Law
                client:
                  first_name: Carla
                  last_name: Gómez
                case:
                  id: '8812'
                  number: 2026-114
                  name: Gómez - I-130
                files:
                - name: birth-certificate.pdf
                  url: https://files.example.com/signed/…
                language_from: spanish
                language_to: english
                return_url: https://app.example.com/cases/8812
                metadata:
                  case_id: '8812'
                  folder_id: '33'
              title: Body
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/checkout/sessions/{session_id}:
    get:
      tags:
      - Embedded checkout
      summary: Read Session
      description: 'A session''s state: `open`, `expired` or `complete` (with its order).'
      operationId: read_session_v1_checkout_sessions__session_id__get
      parameters:
      - name: session_id
        in: path
        required: true
        schema:
          type: string
          title: Session Id
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      - name: x-api-key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Api-Key
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError