Skip to main content
GET
/
v2
/
organizations
/
{entityId}
/
requests
Organization Requests
curl --request GET \
  --url https://api.frankie.one/v2/organizations/{entityId}/requests \
  --header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
  --header 'api_key: <api-key>'
{
  "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "requests": {},
  "requestId": "01HN9XHZN6MGXM9JXG50K59Q85"
}

Authorizations

​
api_key
string
header
required

Headers

​
api_key
string
required

Your API key provided by FrankieOne

Example:

"245c765b124a098d09ef8765...."

​
X-Frankie-CustomerID
string
required

Your Customer ID provided by FrankieOne

Example:

"12345678-1234-1234-1234-123456789012"

​
X-Frankie-CustomerChildID
string

Your Customer Child ID provided by FrankieOne

Example:

"87654321-4321-4321-4321-210987654321"

Path Parameters

​
entityId
string
required

Unique FrankieOne identifier for an entity

Query Parameters

​
requestType
enum<string>[]

The type of request

Available options:
OWNERSHIP,
OWNERSHIP_REPORT,
PROFILE,
PROFILE_REPORT,
REGISTRY_DOCUMENT,
TRUST_DOCUMENT_ANALYSIS
​
status
enum<string>[]

List of statuses to filter the requests upon

The current state of the request. Simplified enum so machines can rely on these to make decisions.

Available options:
PROCESSING,
FAILED,
COMPLETE
​
requestedAfter
string<date-time>

Filter on the createdAt field, results returned are based on being after the value

Response

OK

​
entityId
string

Entities are assigned an auto-generated UUID to ensure global uniqueness, represented as entityId. The entityId allows for precise modification when required. To modify an entity, set the entityId of the entity you wish to update in an update request.

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

​
requests
object

A map of requestTypes to request details. RequestType can be one of reports, ownership

​
requestId
string

The unique request identifier for the API call made.

Example:

"01HN9XHZN6MGXM9JXG50K59Q85"