Organization Request Status

GET

Show status of a previous operation requests on the organization.

Path parameters

entityIdstringRequired

Unique FrankieOne identifier for an entity

requestIdstringRequired

Unique request identifier

Headers

X-Frankie-CustomerIDstringRequired

Your Customer ID provided by FrankieOne

X-Frankie-CustomerChildIDstringOptional

Your Customer Child ID provided by FrankieOne

Response

entityIdstringOptional

Entity’s are assigned an auto-generated UUID to ensure global uniqueness, represented as an 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 call.

requestobjectOptional

Details of an asynchronous request made for this entity

requestIdstringOptional

The unique request ID for the API call made.

GET

1 curl https://api.frankie.one/v2.1/organizations/entityId/requests/requestId \
2      -H "X-Frankie-CustomerID: 12345678-1234-1234-1234-123456789012" \
3      -H "X-Frankie-CustomerChildID: 87654321-4321-4321-4321-210987654321" \
4      -H "api_key: <apiKey>"

200Retrieved

1 {
2   "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3   "request": {
4     "requestId": "requestId",
5     "requestType": "OWNERSHIP",
6     "status": "PROCESSING",
7     "statusDescription": "statusDescription",
8     "responseUrl": "responseUrl",
9     "requestedAt": "2024-01-15T09:30:00Z",
10     "updatedAt": "2024-01-15T09:30:00Z",
11     "nextUpdateAt": "2024-01-15T09:30:00Z",
12     "errors": [
13       {
14         "errorCode": "errorCode",
15         "errorMsg": "errorMsg",
16         "details": [
17           {
18             "issue": "issue",
19             "issueLocation": "issueLocation",
20             "issueType": "issueType"
21           }
22         ]
23       }
24     ]
25   },
26   "requestId": "01HN9XHZN6MGXM9JXG50K59Q85"
27 }

Report Request

Up Next

Built with

1	curl https://api.frankie.one/v2.1/organizations/entityId/requests/requestId \
2	-H "X-Frankie-CustomerID: 12345678-1234-1234-1234-123456789012" \
3	-H "X-Frankie-CustomerChildID: 87654321-4321-4321-4321-210987654321" \
4	-H "api_key: <apiKey>"

1	{
2	"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3	"request": {
4	"requestId": "requestId",
5	"requestType": "OWNERSHIP",
6	"status": "PROCESSING",
7	"statusDescription": "statusDescription",
8	"responseUrl": "responseUrl",
9	"requestedAt": "2024-01-15T09:30:00Z",
10	"updatedAt": "2024-01-15T09:30:00Z",
11	"nextUpdateAt": "2024-01-15T09:30:00Z",
12	"errors": [
13	{
14	"errorCode": "errorCode",
15	"errorMsg": "errorMsg",
16	"details": [
17	{
18	"issue": "issue",
19	"issueLocation": "issueLocation",
20	"issueType": "issueType"
21	}
22	]
23	}
24	]
25	},
26	"requestId": "01HN9XHZN6MGXM9JXG50K59Q85"
27	}