Asynchronous Calls (Background Processes) — FrankieOne

Quick Start

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

1 X-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

Initial Request Validation

The API performs basic validation of your request data.

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)

Background Processing

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

Webhook Notification

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

Original RequestID
Request status summary

Result Retrieval

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

Response Structure

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

Original HTTP Response

The HTTP response that would have been returned in a synchronous call.

Response Payload

Contains either: - Success: The result object matching the original function call - Error: A standard FrankieOne Error Object for non-200 responses

Visual Flow

Asynchronous Flow Diagram — Asynchronous Process Flow

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

Example Implementation

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

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