Sign in

v1

latestOpenAPI 3.0.32026-07-2141248520.9 KB
Individual Entity Elements

Get a list of external references

Get a list of an individual's external references.

get/v2/individuals/{entityId}/externalreferences

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

Response

OK

requestIdstring

The unique request identifier for the API call made.

Example response

{
  "requestId": "01HN9XHZN6MGXM9JXG50K59Q85",
  "externalReferences": [
    {
      "referenceId": "24de15f64-5717-4562-b3fc-2c963f66e23e",
      "sourceId": "93da15f64-5717-4562-b3fc-2c963f6663fe",
      "name": "CUSTOMER-REFERENCE",
      "value": "CUST-00001342",
      "description": "This is the customer ID in the core banking system."
    }
  ]
}