Get a list of external references

GET

Get a list of an individual’s external references.

Path parameters

entityIdstringRequired

Unique FrankieOne identifier for an entity

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.

X-Frankie-UsernamestringOptional

Username provided by API caller

Response

requestIdstringOptional

The unique request ID for the API call made.

externalReferenceslist of objectsOptional

Delete an external reference

Up Next

Built with

1	curl https://api.uat.frankie.one/v2/individuals/entityId/externalreferences \
2	-H "X-Frankie-CustomerID: 12345678-1234-1234-1234-123456789012" \
3	-H "X-Frankie-CustomerChildID: 87654321-4321-4321-4321-210987654321" \
4	-H "X-Frankie-Username: fred.flintstone@frankieone.com" \
5	-H "api_key: <apiKey>"

1	{
2	"requestId": "01HN9XHZN6MGXM9JXG50K59Q85",
3	"externalReferences": [
4	{
5	"name": "CUSTOMER-REFERENCE",
6	"value": "CUST-00001342",
7	"description": "This is the customer id in the core banking system",
8	"referenceId": "24de15f64-5717-4562-b3fc-2c963f66e23e",
9	"sourceId": "93da15f64-5717-4562-b3fc-2c963f6663fe",
10	"type": "SYSTEM"
11	}
12	]
13	}