v1

latestOpenAPI 3.0.32026-07-2141248520.9 KB

Individual Profiles

Update a profile for a given individual entity.

patch/v2/individuals/{entityId}/serviceprofiles/{serviceName}

Headers

api_keystring required

Example:245c765b124a098d09ef8765....

Your API key provided by FrankieOne

X-Frankie-CustomerIDstring required

Example:12345678-1234-1234-1234-123456789012

Your Customer ID provided by FrankieOne

X-Frankie-CustomerChildIDstring

Example:87654321-4321-4321-4321-210987654321

Your Customer Child ID provided by FrankieOne

X-Frankie-Channelstring

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.

X-Frankie-Usernamestring

Example:fred.flintstone@frankieone.com

Username provided by API caller

Request body

Example request

{
  "serviceProfile": {
    "assignee": "Ryan Gosling",
    "reviewer": "Ryan Trahan"
  },
  "comment": {
    "commentId": "55fc5d54-46f7-49c8-bf78-e07ec79cd6e7",
    "text": "Update after speaking to customer over the phone directly."
  }
}

Response

requestIdstring

The unique request identifier for the API call made.

Example response

{
  "requestId": "01HN9XHZN6MGXM9JXG50K59Q85",
  "serviceProfile": {
    "serviceProfileId": "55fc5d54-46f7-49c8-bf78-e07ec79c42fd",
    "organizationType": "SOLE TRADER",
    "country": "AUS",
    "schemaVersion": 2,
    "createdAt": "2024-01-15T02:18:11.365Z",
    "createdRequestId": "01HMR2ERSKCYAVXKS1FKSRT2T4",
    "createdBy": "Ryan Reynolds",
    "updatedAt": "2024-01-15T02:18:11.365Z",
    "updatedBy": "Ryan Reynolds",
    "updatedRequestId": "01HMR2ERSKCYAVXKS1FKSRT2T4",
    "assignee": "Ryan Gosling",
    "reviewer": "Ryan Trahan"
  }
}