Skip to main content
POST
/
your
/
configured
/
path
/
{requestId}
Push Notification Payload
curl --request POST \
  --url https://api.uat.frankie.one/compliance/v1.2/your/configured/path/{requestId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "checkId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "documentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "entityCustomerReference": "AU0123456",
  "entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "extraData": {},
  "function": "entity.create",
  "functionResult": "COMPLETED",
  "linkReference": "https://portal.frankiefinancial.io/entity/3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "message": "Entity successfully created",
  "notificationType": "FUNCTION",
  "requestId": "01BFJA617JMJXEW6G7TDDXNSHX",
  "username": "<string>"
}
'

Path Parameters

​
requestId
string<string>
required

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

Body

application/json

The following fields represent the data you need in order to retrieve the results of the requested function. See the details of the notification API for more.

​
checkId
string<uuid>

If you're calling a processing function of some kind, a check number will be issued. This field will only be present if the function you're calling would normally return a checkId (such as scan, verify, and compare).

​
documentId
string<uuid>

Only supplied if the original request was tied to a document. This will be the same ID that was sent in the original acceptance.

​
entityCustomerReference
string

If the entity in entityId above has had an external service ID attached to it in the entity extraData with kvpKey = customer_reference, then this is that kvpValue

Example:

"AU0123456"

​
entityId
string<uuid>

Only supplied if the original request was tied to an entity. This will be the same ID that was sent in the original acceptance.

​
extraData
object

Additional fields that contain the detailed data that was used to generate the 'message' field. The actual content will depend on the 'notificationType' and 'function'.

​
function
string

Short description of the original function called, or function that was triggered.

Example:

"entity.create"

​
functionResult
enum<string>

High level indication of the final disposition of a backgrounded function

  • "COMPLETED": the request completed (not that the final result is a success, just that we completed)
  • "FAILED": the request failed.
  • "INCOMPLETE": could not complete the request.
Available options:
COMPLETED,
FAILED,
INCOMPLETE
Example:

"COMPLETED"

​
linkReference
string<uri>

URI for resource containing more details about the reason for the notification.

Example:

"https://portal.frankiefinancial.io/entity/3fa85f64-5717-4562-b3fc-2c963f66afa6"

​
message
string

A brief, human readable message describing the reason for the notification.

Example:

"Entity successfully created"

​
notificationType
enum<string>

Indicates the type of notification being pushed.

  • "FUNCTION": A request that you previously backgrounded has completed and this is the notification that is it complete (success is another matter)
  • "RESULT": Like the FUNCTION notification, this tells you that a previously backgrounded request has completed, and that there is a set of results in the payload pointer.
  • "EVENT": There has been a stateful change in a document, entity or some other piece of data that we are holding/monitoring for you. This is an indication that you may wish to take some action.
  • "ALERT": Like the EVENT, except that the severity of the notification indicates that action is almost certainly required.
Available options:
FUNCTION,
RESULT,
EVENT,
ALERT
​
requestId
string<ulid>

Unique identifier for every request. Can be used for tracking down answers with technical support.

Uses the ULID format (a time-based, sortable UUID)

Note: this will be different for every request.

Example:

"01BFJA617JMJXEW6G7TDDXNSHX"

​
username
string

The portal username that initiated the operation that led to this notification. If applicable and available.

Response

The Customer has accepted the notification and we don't need to retry sending it.