Translayte

The services sold online with their unit, whether get_quote can price them, their "from" price in every currency (VAT included where it applies), the currencies, speeds and certifications get_quote accepts, the volume discount tiers and what counts as a page.

{
  "type": "object",
  "properties": {}
}

The language codes get_quote and create_order accept, each with the country whose sworn translators serve the language.

{
  "type": "object",
  "properties": {}
}

ISO 3166-1 alpha-2 country codes for country_of_use (where the translation will be used) and customer_country (where the customer is, which decides VAT), each with whether it is in the Hague Apostille Convention, whether sworn translations are offered for it, and whether document notarisation and apostille are priced online, quoted, or not offered there.

{
  "type": "object",
  "properties": {}
}

Where each service is available: the languages and certifications of certified translation and the countries whose authorities ask for each; the countries document notarisation and apostille & legalisation are offered for, with their routes, formats and turnaround, and whether each is priced online or quoted. Anywhere else is a quote request through the order form.

{
  "type": "object",
  "properties": {}
}

Sends a document to be translated (PDF, image or Office file, up to 25 MB): a file the user attached in chat as `document`, a public https `url`, or `content_base64` with its filename when you hold the bytes yourself. It is measured the way the order form measures an upload; the response carries the billable pages and a file_token to pass to get_quote and create_order, valid for 24 hours and one order. If none of these is possible, create the order from the customer's page count and they upload the document at the status_url after paying.

{
  "type": "object",
  "properties": {
    "document": {
      "description": "A file the user attached in the chat, passed as the host provides it. Use this for attachments; omit url and content_base64.",
      "additionalProperties": false,
      "properties": {
        "download_url": {
          "description": "Temporary download URL of the attachment",
          "type": "string"
        },
        "file_id": {
          "description": "The host's id for the attachment",
          "type": "string"
        },
        "mime_type": {
          "description": "The attachment's MIME type, if known",
          "type": "string"
        },
        "file_name": {
          "description": "The attachment's filename, if known",
          "type": "string"
        }
      },
      "type": "object",
      "required": [
        "download_url",
        "file_id"
      ]
    },
    "url": {
      "description": "A public https URL of the document, ending in its extension, e.g. https://files.example.com/birth-certificate.pdf. Omit when sending document or content_base64.",
      "type": "string"
    },
    "content_base64": {
      "description": "The document's bytes encoded as base64, when you hold the file rather than a URL or an attachment. Send filename with it.",
      "type": "string"
    },
    "filename": {
      "description": "The document's filename with its extension, e.g. birth-certificate.pdf; required with content_base64.",
      "maxLength": 255,
      "type": "string"
    }
  }
}

The price of a certified translation for a language pair, page count (or the documents sent with send_document), speed, certification and currency: the same calculator as checkout, with the ex-VAT lines, the VAT and the total, every certification the pair offers with its total, a delivery estimate and the order_url for the website checkout.

{
  "type": "object",
  "properties": {
    "source_language": {
      "description": "Source language code from list_languages, e.g. en-gb",
      "type": "string"
    },
    "target_language": {
      "description": "Target language code from list_languages, e.g. es",
      "type": "string"
    },
    "quantity": {
      "description": "Pages to translate (a page is up to 250 words). Optional when file_tokens are given: the documents are measured instead, and a quantity can only raise the measured count.",
      "minimum": 1,
      "maximum": 999,
      "type": "integer"
    },
    "file_tokens": {
      "description": "Tokens from send_document for the documents to translate.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "speed": {
      "description": "standard, next_day (+25%) or same_day (+100%)",
      "enum": [
        "standard",
        "next_day",
        "same_day"
      ],
      "type": "string"
    },
    "certification": {
      "description": "Omit for standard; the response lists every option the pair offers with its total.",
      "enum": [
        "standard",
        "sworn",
        "statement_of_truth",
        "certified_translator_canada",
        "naati"
      ],
      "type": "string"
    },
    "currency": {
      "description": "The currency to quote in; each is its own price sheet. Defaults to GBP.",
      "enum": [
        "GBP",
        "EUR",
        "USD",
        "AUD",
        "CAD",
        "BRL",
        "ZAR"
      ],
      "type": "string"
    },
    "country_of_use": {
      "description": "ISO 3166-1 alpha-2 code of the country the translation is for, e.g. ES for a sworn translation for Spain.",
      "minLength": 2,
      "maxLength": 2,
      "type": "string"
    },
    "customer_country": {
      "description": "ISO 3166-1 alpha-2 code of the customer's country. Outside GB no VAT is charged.",
      "minLength": 2,
      "maxLength": 2,
      "type": "string"
    }
  },
  "required": [
    "source_language",
    "target_language"
  ]
}

Places an unpaid order for the customer from the same arguments as get_quote plus their name, email and E.164 phone. The response carries signed links: pay_url is our payment page (card, PayPal, Google Pay, Apple Pay) to give the customer, status_url shows the order and collects any missing documents. Links last 48 hours. A customer whose email already has an account receives the links by email instead, and the response says so: tell them to check their inbox. Documents can be sent first with send_document, or uploaded by the customer at the status_url after paying when you create the order from a page count. Pass idempotency_key so a retry never places a second order.

{
  "type": "object",
  "properties": {
    "source_language": {
      "description": "Source language code from list_languages, e.g. en-gb",
      "type": "string"
    },
    "target_language": {
      "description": "Target language code from list_languages, e.g. es",
      "type": "string"
    },
    "quantity": {
      "description": "Pages to translate (a page is up to 250 words). Optional when file_tokens are given: the documents are measured instead, and a quantity can only raise the measured count.",
      "minimum": 1,
      "maximum": 999,
      "type": "integer"
    },
    "file_tokens": {
      "description": "Tokens from send_document for the documents to translate.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "speed": {
      "description": "standard, next_day (+25%) or same_day (+100%)",
      "enum": [
        "standard",
        "next_day",
        "same_day"
      ],
      "type": "string"
    },
    "certification": {
      "description": "Omit for standard; the response lists every option the pair offers with its total.",
      "enum": [
        "standard",
        "sworn",
        "statement_of_truth",
        "certified_translator_canada",
        "naati"
      ],
      "type": "string"
    },
    "currency": {
      "description": "The currency to quote in; each is its own price sheet. Defaults to GBP.",
      "enum": [
        "GBP",
        "EUR",
        "USD",
        "AUD",
        "CAD",
        "BRL",
        "ZAR"
      ],
      "type": "string"
    },
    "country_of_use": {
      "description": "ISO 3166-1 alpha-2 code of the country the translation is for, e.g. ES for a sworn translation for Spain.",
      "minLength": 2,
      "maxLength": 2,
      "type": "string"
    },
    "customer_country": {
      "description": "ISO 3166-1 alpha-2 code of the customer's country. Outside GB no VAT is charged.",
      "minLength": 2,
      "maxLength": 2,
      "type": "string"
    },
    "name": {
      "description": "The customer's full name",
      "type": "string"
    },
    "email": {
      "description": "The customer's email address",
      "format": "email",
      "type": "string"
    },
    "phone": {
      "description": "The customer's phone number in E.164 format, e.g. +14155552671",
      "type": "string"
    },
    "notes": {
      "description": "Anything the translator should know: names to keep, the purpose, formatting wishes.",
      "maxLength": 2000,
      "type": "string"
    },
    "idempotency_key": {
      "description": "Your own unique key for this order attempt; a retry with the same key within a day returns the order already placed instead of a second one.",
      "maxLength": 64,
      "type": "string"
    }
  },
  "required": [
    "source_language",
    "target_language",
    "name",
    "email",
    "phone"
  ]
}

Where an order stands, from its signed status_url: status, payment, balance due, due date, documents received, the next action (pay, upload_documents, wait) and fresh links. The link is the credential; nothing else identifies an order.

{
  "type": "object",
  "properties": {
    "status_url": {
      "description": "The status_url returned by create_order or sent to the customer",
      "type": "string"
    }
  },
  "required": [
    "status_url"
  ]
}

Emails the customer fresh pay and status links for an order placed with their email address. The answer is the same whether or not the order and email match, so it reveals nothing about other people's orders.

{
  "type": "object",
  "properties": {
    "email": {
      "description": "The email address the order was placed with",
      "format": "email",
      "type": "string"
    },
    "order_id": {
      "description": "The order number",
      "minimum": 1,
      "type": "integer"
    }
  },
  "required": [
    "email",
    "order_id"
  ]
}