Asynchronous Calls (Background Processes)

FrankieOne API supports both synchronous and asynchronous operations, giving you flexibility in how you handle requests. Here’s everything you need to know about using asynchronous processes.

Quick Start

To make an asynchronous call, simply add this header to your request:

1X-Frankie-Background: 1

By default, all operations are synchronous unless specified otherwise in the API documentation.

Not all endpoints support asynchronous operations (e.g., GET requests). Check the specific endpoint documentation for availability.

How Asynchronous Calls Work

1

Initial Request Validation

The API performs basic validation of your request data.

2

Acceptance Response

If validation passes, you’ll receive an HTTP 202 ACCEPT response containing:

  • RequestID
  • Entity/DocumentID
  • CheckID (for check requests)
  • Portal link (when applicable)
3

Background Processing

The service processes your request asynchronously and generates a result notification.

4

Webhook Notification

Once processing completes, you’ll receive a webhook notification containing:

  • Original RequestID
  • Request status summary
5

Result Retrieval

Use the /retrieve API endpoint to fetch the complete results.

Response Structure

When retrieving results, you’ll receive two main components:

Visual Flow

Asynchronous Flow Diagram

Asynchronous Process Flow

Need help configuring webhooks? Contact our developer support team for assistance with FrankieOne configuration.

Example Implementation

1const headers = {
2  'X-Frankie-Background': '1',
3  'Content-Type': 'application/json'
4};
5
6// Make async request
7const response = await fetch('https://api.frankieone.com/endpoint', {
8method: 'POST',
9headers,
10body: JSON.stringify(payload)
11});
12
13// Handle 202 Accepted response
14if (response.status === 202) {
15const { requestId } = await response.json();
16// Store requestId for later use when webhook arrives
17}
Built with