Skip to main content
GET
/
v2
/
organizations
/
{entityId}
/
requests
/
{requestId}
Organization Request Status
curl --request GET \
  --url https://api.frankie.one/v2/organizations/{entityId}/requests/{requestId} \
  --header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
  --header 'api_key: <api-key>'
{
  "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "request": {
    "requestId": "<string>",
    "requestType": "OWNERSHIP",
    "status": "PROCESSING",
    "statusDescription": "<string>",
    "responseUrl": "<string>",
    "requestedAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "nextUpdateAt": "2023-11-07T05:31:56Z",
    "errors": [
      {
        "errorCode": "<string>",
        "errorMsg": "<string>",
        "details": [
          {
            "issue": "<string>",
            "issueLocation": "<string>",
            "issueType": "<string>"
          }
        ]
      }
    ]
  },
  "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

​
requestId
string
required

Unique request identifier

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"

​
request
object

Details of an asynchronous request made for this entity

​
requestId
string

The unique request identifier for the API call made.

Example:

"01HN9XHZN6MGXM9JXG50K59Q85"