Organization Profile

POST

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

X-Frankie-CustomerIDstringRequired

Your Customer ID provided by FrankieOne

X-Frankie-CustomerChildIDstringOptional

Your Customer Child ID provided by FrankieOne

X-Frankie-ChannelstringOptional

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

includeDeregisteredCompaniesbooleanOptional

Whether to include deregistered companies in the response. Defaults to false. If flag is false, and the requested company is deregistered, then error is returned. If flag is true, and the requested company is deregistered, then a standard profile response provided including details about the deregistered company. If flag is true, and the requested company is not deregistered, then a standard profile response is provided. Note: this flag only works to get a domestic profile, otherwise flag will be ignored.

forceRefreshbooleanOptional

This will fetch the latest information from the registry if set to true.

Request

This endpoint expects an object.
organizationTokenstringOptional

This is the unique Frankie token that contains all the information required from lookup that are needed in succeeding steps

organizationRegistrationobjectOptional
externalReferenceslist of objectsOptional
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.

Response

OK

requestIdstring

The unique request ID for the API call made.

organizationobjectOptional

This is the complete Organization Model

Built with