Organization Profile
Create an entity based on Profile information retrieved for an organization from registries specific to a region. This will get organization details and official details where available.
Headers
api_key
api_key
Your API key provided by FrankieOne
X-Frankie-CustomerID
Your Customer ID provided by FrankieOne
X-Frankie-CustomerChildID
Your Customer Child ID provided by FrankieOne
X-Frankie-Channel
Open string that can be used to define the “channel” the request comes in from. It can potentially be used in routing and risk calculations upon request. Default values that can be used are: api portal smartui Any alphanumeric string is supported though. Anything over 64 characters will be truncated.
Query parameters
forceRefresh
This will fetch the latest information from the registry if set to true.
Request
organizationToken
This is the unique Frankie token that contains all the information required from lookup that are needed in succeeding steps
organizationRegistration
externalReferences
entityId
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.
Response
OK
requestId
The unique request ID for the API call made.
organization
This is the complete Organization Model