Skip to main content
GET
/
retrieve
/
response
/
{requestId}
(Re)retrieve Response Result.
curl --request GET \
  --url https://api.uat.frankie.one/compliance/v1.2/retrieve/response/{requestId} \
  --header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
  --header 'api_key: <api-key>'
{
  "origHTTPstatus": 123,
  "payload": {}
}

Authorizations

​
api_key
string
header
required

API key issued by Frankie Financial. This will rotate regularly.

Headers

​
X-Frankie-CustomerID
string<uuid>
required

Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time.

​
X-Frankie-CustomerChildID
string<uuid>

If, as a Frankie Customer, you are acting on behalf of your own customers, then you can populate this field with a Frankie-assigned ID.

Note: If using a CustomerChildID, you will also need a separate api_key for each child.

Any documents, checks, entities that are created when this field has been populated will now be tied to this CustomerID + CustomerChildID combination. Just as Customers cannot see data created by other Customers, so too a Customer's Children will not be able to see each other's data.

A Customer can see the documents/entities and checks of all their Children.

Path Parameters

​
requestId
string<string>
required

This will be the same RequestId that was sent in the 202 acceptance response.

Query Parameters

​
payload
enum<string>

Specifies the type of the payload field in the retrieved response. Default is 'string'.

Available options:
string,
object

Response

The request was valid and able to be processed in some fashion. Results may or may not be successful, but it was completed as far as practical with no actual errors.

When sent a notification or alert, you'll call the /retrive/response/{requestId} function

This will return the original response

​
origHTTPstatus
integer

This will be the HTTP response code that was returned originally (200, 404, etc).

In the case where you're requesting the result of a callback (previously backgrounded call), then this is the response that would have been sent, had you waited for the call to finish.

​
payload
object

This is a placeholder field. It will actually be a JSON object that is the payload that would have been returned (or was returned) in the original request. You'll need to process this as if it were the original response, and act accordingly.