v1
latestOpenAPI 3.0.32026-07-2141248520.9 KBIndividual Entities
Update an individual entity
Update any of the information of the Individual Entity with the matching entity ID.
patch/v2/individuals/{entityId}
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
{
"individual": {
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"schemaVersion": 2,
"addresses": [
{
"validFrom": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"normalized": "1990-03-31"
},
"validTo": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"normalized": "1990-03-31"
}
}
],
"phoneNumbers": [
{
"phoneNumberId": "ad165f64-5717-4562-b3fc-2c963f66bfa9",
"isPreferred": true,
"type": "MOBILE",
"sourceId": "14fd5f64-5717-4562-b3fc-2c963f66ba34",
"country": "AUS",
"number": "0426192340",
"linkedAddresses": [
{
"addressId": "fa335f64-5717-4562-b3fc-2c963f66cf41"
}
]
}
],
"emailAddresses": [
{
"emailAddressId": "aa385f64-5717-4562-b3fc-2c963f66af21",
"type": "WORK",
"sourceId": "31dd15f64-5717-4562-b3fc-2c963f66234d",
"email": "leonardo_dc@outlook.com",
"linkedAddresses": [
{
"addressId": "adc215f64-5717-4562-b3fc-2c963f66222a"
}
]
}
],
"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."
}
],
"documents": {
"REPORT": [
{
"documentId": "92de15f64-5717-4562-b3fc-2c963f6665a7",
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"expiryDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"normalized": "1990-03-31"
},
"issueDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"normalized": "1990-03-31"
},
"primaryIdentifier": "000734130",
"secondaryIdentifier": "P0001975",
"subtype": "Photo Comparison",
"subdivision": "VIC",
"country": "AUS",
"createdAt": "2024-01-15T02:18:11.365Z",
"updatedAt": "2025-01-16T02:18:11.365Z",
"validFrom": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"normalized": "1990-03-31"
},
"validTo": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"normalized": "1990-03-31"
},
"sourceId": "324f15f64-5717-4562-b3fc-2c963f66ffa1",
"supplementaryData": {
"reference": "1"
},
"attachments": [
{
"data": {
"uri": "https://s3.amazonaws.com/dev/41963bc5feff322020137de233c3be0fac6/croppedFrontID/38d54232-b840-431d-b248-152345fe214.jpg"
}
}
]
}
],
"SUPPORTING": [
{
"documentId": "92de15f64-5717-4562-b3fc-2c963f6665a7",
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"expiryDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"normalized": "1990-03-31"
},
"issueDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"normalized": "1990-03-31"
},
"primaryIdentifier": "000734130",
"secondaryIdentifier": "P0001975",
"subtype": "Photo Comparison",
"subdivision": "VIC",
"country": "AUS",
"createdAt": "2024-01-15T02:18:11.365Z",
"updatedAt": "2025-01-16T02:18:11.365Z",
"validFrom": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"normalized": "1990-03-31"
},
"validTo": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"normalized": "1990-03-31"
},
"sourceId": "324f15f64-5717-4562-b3fc-2c963f66ffa1",
"supplementaryData": {
"reference": "1"
},
"attachments": [
{
"data": {
"uri": "https://s3.amazonaws.com/dev/41963bc5feff322020137de233c3be0fac6/croppedFrontID/38d54232-b840-431d-b248-152345fe214.jpg"
}
}
]
}
],
"IDENTITY": [
{
"documentId": "92de15f64-5717-4562-b3fc-2c963f6665a7",
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"expiryDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"normalized": "1990-03-31"
},
"issueDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"normalized": "1990-03-31"
},
"primaryIdentifier": "000734130",
"secondaryIdentifier": "P0001975",
"subtype": "Photo Comparison",
"subdivision": "VIC",
"country": "AUS",
"createdAt": "2024-01-15T02:18:11.365Z",
"updatedAt": "2025-01-16T02:18:11.365Z",
"validFrom": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"normalized": "1990-03-31"
},
"validTo": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"normalized": "1990-03-31"
},
"sourceId": "324f15f64-5717-4562-b3fc-2c963f66ffa1",
"supplementaryData": {
"reference": "1"
},
"attachments": [
{
"data": {
"uri": "https://s3.amazonaws.com/dev/41963bc5feff322020137de233c3be0fac6/croppedFrontID/38d54232-b840-431d-b248-152345fe214.jpg"
}
}
]
}
],
"OTHER": [
{
"documentId": "92de15f64-5717-4562-b3fc-2c963f6665a7",
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"expiryDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"normalized": "1990-03-31"
},
"issueDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"normalized": "1990-03-31"
},
"primaryIdentifier": "000734130",
"secondaryIdentifier": "P0001975",
"subtype": "Photo Comparison",
"subdivision": "VIC",
"country": "AUS",
"createdAt": "2024-01-15T02:18:11.365Z",
"updatedAt": "2025-01-16T02:18:11.365Z",
"validFrom": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"normalized": "1990-03-31"
},
"validTo": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"normalized": "1990-03-31"
},
"sourceId": "324f15f64-5717-4562-b3fc-2c963f66ffa1",
"supplementaryData": {
"reference": "1"
},
"attachments": [
{
"data": {
"uri": "https://s3.amazonaws.com/dev/41963bc5feff322020137de233c3be0fac6/croppedFrontID/38d54232-b840-431d-b248-152345fe214.jpg"
}
}
]
}
]
},
"name": {
"nameId": "87654321-4321-4321-4321-210987654321",
"language": "eng",
"givenName": "John",
"middleName": "R",
"familyName": "Doe",
"prefix": "Dr.",
"suffix": "Jr.",
"sourceId": "87654321-4321-4321-4321-210987654322",
"displayName": "John Doe"
},
"alternateNames": [
{
"nameId": "87654321-4321-4321-4321-210987654321",
"language": "eng",
"givenName": "John",
"middleName": "R",
"familyName": "Doe",
"prefix": "Dr.",
"suffix": "Jr.",
"sourceId": "87654321-4321-4321-4321-210987654322",
"displayName": "John Doe",
"type": "OTHER"
}
],
"dateOfBirth": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"normalized": "1990-03-31"
},
"alternateDatesOfBirth": [
{
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"normalized": "1990-03-31"
}
],
"placeOfBirth": {
"addressId": "6ad15f64-5717-4562-b3fc-2c963f66abf9",
"sourceId": "1da65f64-5717-4562-b3fc-2c963f669fba",
"longForm": "525 Kent Dr, Harlem NY 10037, USA",
"unstructuredLongForm": "3A/525 KENT DRIVE HARLEM NEW YORK 10036 USA",
"unitNumber": "3A",
"buildingName": "EQ Tower",
"streetName": "Kent",
"streetNumber": "525",
"streetType": "Dr",
"neighborhood": "Harlem",
"locality": "Manhattan",
"district": "New York County",
"subdivision": "NY",
"country": "USA",
"postalCode": "10037"
},
"nationality": "AUS",
"consents": [
{
"type": "UNDER18",
"sourceId": "93da15f64-5717-4562-b3fc-2c963f6663fe"
}
],
"relationships": {
"duplicates": [
{
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"origin": {
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
}
]
}
},
"comment": {
"commentId": "55fc5d54-46f7-49c8-bf78-e07ec79cd6e7",
"text": "Update after speaking to customer over the phone directly."
}
}Response
OK
Example response
{
"individual": {
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"schemaVersion": 2,
"addresses": [
{
"validFrom": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"normalized": "1990-03-31"
},
"validTo": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"normalized": "1990-03-31"
}
}
],
"phoneNumbers": [
{
"phoneNumberId": "ad165f64-5717-4562-b3fc-2c963f66bfa9",
"isPreferred": true,
"type": "MOBILE",
"sourceId": "14fd5f64-5717-4562-b3fc-2c963f66ba34",
"country": "AUS",
"number": "0426192340",
"linkedAddresses": [
{
"addressId": "fa335f64-5717-4562-b3fc-2c963f66cf41"
}
]
}
],
"emailAddresses": [
{
"emailAddressId": "aa385f64-5717-4562-b3fc-2c963f66af21",
"type": "WORK",
"sourceId": "31dd15f64-5717-4562-b3fc-2c963f66234d",
"email": "leonardo_dc@outlook.com",
"linkedAddresses": [
{
"addressId": "adc215f64-5717-4562-b3fc-2c963f66222a"
}
]
}
],
"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."
}
],
"documents": {
"REPORT": [
{
"documentId": "92de15f64-5717-4562-b3fc-2c963f6665a7",
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"expiryDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"normalized": "1990-03-31"
},
"issueDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"normalized": "1990-03-31"
},
"primaryIdentifier": "000734130",
"secondaryIdentifier": "P0001975",
"subtype": "Photo Comparison",
"subdivision": "VIC",
"country": "AUS",
"createdAt": "2024-01-15T02:18:11.365Z",
"updatedAt": "2025-01-16T02:18:11.365Z",
"validFrom": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"normalized": "1990-03-31"
},
"validTo": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"normalized": "1990-03-31"
},
"sourceId": "324f15f64-5717-4562-b3fc-2c963f66ffa1",
"supplementaryData": {
"reference": "1"
},
"attachments": [
{
"data": {
"uri": "https://s3.amazonaws.com/dev/41963bc5feff322020137de233c3be0fac6/croppedFrontID/38d54232-b840-431d-b248-152345fe214.jpg"
}
}
]
}
],
"SUPPORTING": [
{
"documentId": "92de15f64-5717-4562-b3fc-2c963f6665a7",
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"expiryDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"normalized": "1990-03-31"
},
"issueDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"normalized": "1990-03-31"
},
"primaryIdentifier": "000734130",
"secondaryIdentifier": "P0001975",
"subtype": "Photo Comparison",
"subdivision": "VIC",
"country": "AUS",
"createdAt": "2024-01-15T02:18:11.365Z",
"updatedAt": "2025-01-16T02:18:11.365Z",
"validFrom": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"normalized": "1990-03-31"
},
"validTo": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"normalized": "1990-03-31"
},
"sourceId": "324f15f64-5717-4562-b3fc-2c963f66ffa1",
"supplementaryData": {
"reference": "1"
},
"attachments": [
{
"data": {
"uri": "https://s3.amazonaws.com/dev/41963bc5feff322020137de233c3be0fac6/croppedFrontID/38d54232-b840-431d-b248-152345fe214.jpg"
}
}
]
}
],
"IDENTITY": [
{
"documentId": "92de15f64-5717-4562-b3fc-2c963f6665a7",
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"expiryDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"normalized": "1990-03-31"
},
"issueDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"normalized": "1990-03-31"
},
"primaryIdentifier": "000734130",
"secondaryIdentifier": "P0001975",
"subtype": "Photo Comparison",
"subdivision": "VIC",
"country": "AUS",
"createdAt": "2024-01-15T02:18:11.365Z",
"updatedAt": "2025-01-16T02:18:11.365Z",
"validFrom": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"normalized": "1990-03-31"
},
"validTo": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"normalized": "1990-03-31"
},
"sourceId": "324f15f64-5717-4562-b3fc-2c963f66ffa1",
"supplementaryData": {
"reference": "1"
},
"attachments": [
{
"data": {
"uri": "https://s3.amazonaws.com/dev/41963bc5feff322020137de233c3be0fac6/croppedFrontID/38d54232-b840-431d-b248-152345fe214.jpg"
}
}
]
}
],
"OTHER": [
{
"documentId": "92de15f64-5717-4562-b3fc-2c963f6665a7",
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"expiryDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"normalized": "1990-03-31"
},
"issueDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"normalized": "1990-03-31"
},
"primaryIdentifier": "000734130",
"secondaryIdentifier": "P0001975",
"subtype": "Photo Comparison",
"subdivision": "VIC",
"country": "AUS",
"createdAt": "2024-01-15T02:18:11.365Z",
"updatedAt": "2025-01-16T02:18:11.365Z",
"validFrom": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"normalized": "1990-03-31"
},
"validTo": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"normalized": "1990-03-31"
},
"sourceId": "324f15f64-5717-4562-b3fc-2c963f66ffa1",
"supplementaryData": {
"reference": "1"
},
"attachments": [
{
"data": {
"uri": "https://s3.amazonaws.com/dev/41963bc5feff322020137de233c3be0fac6/croppedFrontID/38d54232-b840-431d-b248-152345fe214.jpg"
}
}
]
}
]
},
"name": {
"nameId": "87654321-4321-4321-4321-210987654321",
"language": "eng",
"givenName": "John",
"middleName": "R",
"familyName": "Doe",
"prefix": "Dr.",
"suffix": "Jr.",
"sourceId": "87654321-4321-4321-4321-210987654322",
"displayName": "John Doe"
},
"alternateNames": [
{
"nameId": "87654321-4321-4321-4321-210987654321",
"language": "eng",
"givenName": "John",
"middleName": "R",
"familyName": "Doe",
"prefix": "Dr.",
"suffix": "Jr.",
"sourceId": "87654321-4321-4321-4321-210987654322",
"displayName": "John Doe",
"type": "OTHER"
}
],
"dateOfBirth": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"normalized": "1990-03-31"
},
"alternateDatesOfBirth": [
{
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"normalized": "1990-03-31"
}
],
"placeOfBirth": {
"addressId": "6ad15f64-5717-4562-b3fc-2c963f66abf9",
"sourceId": "1da65f64-5717-4562-b3fc-2c963f669fba",
"longForm": "525 Kent Dr, Harlem NY 10037, USA",
"unstructuredLongForm": "3A/525 KENT DRIVE HARLEM NEW YORK 10036 USA",
"unitNumber": "3A",
"buildingName": "EQ Tower",
"streetName": "Kent",
"streetNumber": "525",
"streetType": "Dr",
"neighborhood": "Harlem",
"locality": "Manhattan",
"district": "New York County",
"subdivision": "NY",
"country": "USA",
"postalCode": "10037"
},
"nationality": "AUS",
"consents": [
{
"type": "UNDER18",
"sourceId": "93da15f64-5717-4562-b3fc-2c963f6663fe"
}
],
"relationships": {
"duplicates": [
{
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"origin": {
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
}
]
}
},
"serviceProfiles": [
{
"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"
}
],
"requestId": "01HN9XHZN6MGXM9JXG50K59Q85"
}