Changelog - ImmiTranslate API

Open the sandbox yourself from Settings, API keys in your ImmiTranslate account: your sandbox account is created and you’re signed in automatically.
Get Account masks a saved bank account’s us_bank_routing_number to its last 4 digits, like *****0000. Bank account numbers were already limited to us_bank_last4.

Get Account now returns user, the person the API key or access token acts for, and app for OAuth access tokens. Each user also has a role.
A payment that fails now returns HTTP 402 with "code": "payment_failed" and a message, instead of 200. result and data.message are still included. autobuy on Create Quote returns the same error, with the quote, when its payment fails.
OAuth apps can revoke a token to disconnect from an account, and receive webhooks for the quotes they create and for connections.
Quotes include payment_url, the quote’s page on ImmiTranslate, where the customer can pay. It is null until the quote is ready.
Order webhooks include data.quote, the token of the quote the order was placed from, or null for orders placed without a quote.

Added OAuth apps: platforms can let their users connect an ImmiTranslate account, creating one first if needed, and call the API with an access token instead of an API key.

A partner token (partner.token or the Partner-Id header) is no longer limited to partners that belong to your account. The quote is placed on your API key’s account and attributed to the partner the token identifies.

Added per-file webhook events: file_created is delivered for each translation when an order enters review (and for replacement files after a revision), and file_deleted when a translation is no longer available, such as when it has been replaced by a revision. See Event Types for payload details.

The Create Quote endpoint now accepts a Partner Object, allowing a quote (and any resulting order) to be attributed to a partner via its prt_ token. The token may also be provided as the Partner-Id HTTP header. The existing partner referral fields are now documented as part of the Partner Object.

The Create Quote endpoint now accepts an optional webhook parameter, allowing a webhook URL to be assigned to an individual quote and any resulting order. When both a quote-level and an account-level webhook URL are configured, events are delivered to both. See Webhooks for details.
Webhooks are now delivered for lifecycle transitions that previously did not emit events: order creation across every payment channel, quote approval on accounts with invoicing enabled, order approval and completion following translation approval, and orders placed on hold.
Added a complete list of webhook Event Types.

Added the Request a Revision endpoint, which lets you request a revision on a specific translation.

The Approve Order endpoint now approves the order’s translations directly. By default, every translation is approved. An optional files parameter may be provided to approve only specific translations.

The Files endpoint now allows a remote URL to be provided.
The Files endpoint no longer permits user-provided metadata. Our system will now generate metadata automatically based on the document content.

The Files endpoint now contains an optional metadata attribute for existing machine translations and for OCR data. We recommend providing this data when it is already being utilized in an existing system. NOTE: As of July 18, 2025, we no longer accept user-provided metadata.