Skip to main content
PATCH
/
v2
/
individuals
/
{entityId}
Update an individual entity
curl --request PATCH \
  --url https://api.uat.frankie.one/v2/individuals/{entityId} \
  --header 'Content-Type: application/json' \
  --header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
  --header 'api_key: <api-key>' \
  --data '
{
  "individual": {
    "addresses": [
      {
        "country": "<string>",
        "addressId": "<string>",
        "type": "OTHER",
        "typeDescription": "<string>",
        "validFrom": {
          "year": "1990",
          "month": "03",
          "day": "27",
          "unstructured": "12 Rajab 1445 AH",
          "type": "GREGORIAN"
        },
        "validTo": {
          "year": "1990",
          "month": "03",
          "day": "27",
          "unstructured": "12 Rajab 1445 AH",
          "type": "GREGORIAN"
        },
        "longForm": "<string>",
        "unitNumber": "<string>",
        "buildingName": "<string>",
        "streetName": "<string>",
        "streetNumber": "<string>",
        "streetType": "<string>",
        "neighborhood": "<string>",
        "locality": "<string>",
        "district": "<string>",
        "subdivision": "<string>",
        "postalCode": "<string>",
        "careOf": "<string>",
        "status": "CURRENT"
      }
    ],
    "phoneNumbers": [
      {
        "phoneNumberId": "ad165f64-5717-4562-b3fc-2c963f66bfa9",
        "isPreferred": true,
        "type": "MOBILE",
        "country": "AUS",
        "number": "0426192340",
        "unstructuredLongForm": "<string>"
      }
    ],
    "emailAddresses": [
      {
        "emailAddressId": "aa385f64-5717-4562-b3fc-2c963f66af21",
        "type": "WORK",
        "email": "[email protected]",
        "isPreferred": true
      }
    ],
    "customAttributes": {},
    "externalReferences": [
      {
        "name": "CUSTOMER-REFERENCE",
        "value": "CUST-00001342",
        "type": "CUSTOMER",
        "description": "This is the customer ID in the core banking system."
      }
    ],
    "documents": {
      "REPORT": [
        {
          "type": "OTHER",
          "country": "AUS",
          "class": "IDENTITY",
          "documentId": "92de15f64-5717-4562-b3fc-2c963f6665a7",
          "expiryDate": {
            "year": "1990",
            "month": "03",
            "day": "27",
            "unstructured": "12 Rajab 1445 AH",
            "type": "GREGORIAN"
          },
          "issueDate": {
            "year": "1990",
            "month": "03",
            "day": "27",
            "unstructured": "12 Rajab 1445 AH",
            "type": "GREGORIAN"
          },
          "primaryIdentifier": "000734130",
          "secondaryIdentifier": "P0001975",
          "subtype": "Photo Comparison",
          "subdivision": "VIC",
          "validFrom": {
            "year": "1990",
            "month": "03",
            "day": "27",
            "unstructured": "12 Rajab 1445 AH",
            "type": "GREGORIAN"
          },
          "validTo": {
            "year": "1990",
            "month": "03",
            "day": "27",
            "unstructured": "12 Rajab 1445 AH",
            "type": "GREGORIAN"
          },
          "supplementaryData": {
            "type": "NATIONAL_HEALTH_ID",
            "reference": "1",
            "nameOnCardLine1": "<string>",
            "nameOnCardLine2": "<string>",
            "nameOnCardLine3": "<string>",
            "nameOnCardLine4": "<string>",
            "middleNameOnCard": "<string>"
          },
          "customAttributes": {},
          "attachments": [
            {
              "data": {
                "uri": "https://s3.amazonaws.com/dev/41963bc5feff322020137de233c3be0fac6/croppedFrontID/38d54232-b840-431d-b248-152345fe214.jpg"
              },
              "attachmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "filename": "<string>",
              "mimeType": "<string>",
              "pageNumber": 123,
              "side": "FRONT",
              "type": "<string>",
              "location": "<string>",
              "lastMalwareScanAt": "2023-11-07T05:31:56Z"
            }
          ]
        }
      ],
      "SUPPORTING": [
        {
          "type": "OTHER",
          "country": "AUS",
          "class": "IDENTITY",
          "documentId": "92de15f64-5717-4562-b3fc-2c963f6665a7",
          "expiryDate": {
            "year": "1990",
            "month": "03",
            "day": "27",
            "unstructured": "12 Rajab 1445 AH",
            "type": "GREGORIAN"
          },
          "issueDate": {
            "year": "1990",
            "month": "03",
            "day": "27",
            "unstructured": "12 Rajab 1445 AH",
            "type": "GREGORIAN"
          },
          "primaryIdentifier": "000734130",
          "secondaryIdentifier": "P0001975",
          "subtype": "Photo Comparison",
          "subdivision": "VIC",
          "validFrom": {
            "year": "1990",
            "month": "03",
            "day": "27",
            "unstructured": "12 Rajab 1445 AH",
            "type": "GREGORIAN"
          },
          "validTo": {
            "year": "1990",
            "month": "03",
            "day": "27",
            "unstructured": "12 Rajab 1445 AH",
            "type": "GREGORIAN"
          },
          "supplementaryData": {
            "type": "NATIONAL_HEALTH_ID",
            "reference": "1",
            "nameOnCardLine1": "<string>",
            "nameOnCardLine2": "<string>",
            "nameOnCardLine3": "<string>",
            "nameOnCardLine4": "<string>",
            "middleNameOnCard": "<string>"
          },
          "customAttributes": {},
          "attachments": [
            {
              "data": {
                "uri": "https://s3.amazonaws.com/dev/41963bc5feff322020137de233c3be0fac6/croppedFrontID/38d54232-b840-431d-b248-152345fe214.jpg"
              },
              "attachmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "filename": "<string>",
              "mimeType": "<string>",
              "pageNumber": 123,
              "side": "FRONT",
              "type": "<string>",
              "location": "<string>",
              "lastMalwareScanAt": "2023-11-07T05:31:56Z"
            }
          ]
        }
      ],
      "IDENTITY": [
        {
          "type": "OTHER",
          "country": "AUS",
          "class": "IDENTITY",
          "documentId": "92de15f64-5717-4562-b3fc-2c963f6665a7",
          "expiryDate": {
            "year": "1990",
            "month": "03",
            "day": "27",
            "unstructured": "12 Rajab 1445 AH",
            "type": "GREGORIAN"
          },
          "issueDate": {
            "year": "1990",
            "month": "03",
            "day": "27",
            "unstructured": "12 Rajab 1445 AH",
            "type": "GREGORIAN"
          },
          "primaryIdentifier": "000734130",
          "secondaryIdentifier": "P0001975",
          "subtype": "Photo Comparison",
          "subdivision": "VIC",
          "validFrom": {
            "year": "1990",
            "month": "03",
            "day": "27",
            "unstructured": "12 Rajab 1445 AH",
            "type": "GREGORIAN"
          },
          "validTo": {
            "year": "1990",
            "month": "03",
            "day": "27",
            "unstructured": "12 Rajab 1445 AH",
            "type": "GREGORIAN"
          },
          "supplementaryData": {
            "type": "NATIONAL_HEALTH_ID",
            "reference": "1",
            "nameOnCardLine1": "<string>",
            "nameOnCardLine2": "<string>",
            "nameOnCardLine3": "<string>",
            "nameOnCardLine4": "<string>",
            "middleNameOnCard": "<string>"
          },
          "customAttributes": {},
          "attachments": [
            {
              "data": {
                "uri": "https://s3.amazonaws.com/dev/41963bc5feff322020137de233c3be0fac6/croppedFrontID/38d54232-b840-431d-b248-152345fe214.jpg"
              },
              "attachmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "filename": "<string>",
              "mimeType": "<string>",
              "pageNumber": 123,
              "side": "FRONT",
              "type": "<string>",
              "location": "<string>",
              "lastMalwareScanAt": "2023-11-07T05:31:56Z"
            }
          ]
        }
      ],
      "OTHER": [
        {
          "type": "OTHER",
          "country": "AUS",
          "class": "IDENTITY",
          "documentId": "92de15f64-5717-4562-b3fc-2c963f6665a7",
          "expiryDate": {
            "year": "1990",
            "month": "03",
            "day": "27",
            "unstructured": "12 Rajab 1445 AH",
            "type": "GREGORIAN"
          },
          "issueDate": {
            "year": "1990",
            "month": "03",
            "day": "27",
            "unstructured": "12 Rajab 1445 AH",
            "type": "GREGORIAN"
          },
          "primaryIdentifier": "000734130",
          "secondaryIdentifier": "P0001975",
          "subtype": "Photo Comparison",
          "subdivision": "VIC",
          "validFrom": {
            "year": "1990",
            "month": "03",
            "day": "27",
            "unstructured": "12 Rajab 1445 AH",
            "type": "GREGORIAN"
          },
          "validTo": {
            "year": "1990",
            "month": "03",
            "day": "27",
            "unstructured": "12 Rajab 1445 AH",
            "type": "GREGORIAN"
          },
          "supplementaryData": {
            "type": "NATIONAL_HEALTH_ID",
            "reference": "1",
            "nameOnCardLine1": "<string>",
            "nameOnCardLine2": "<string>",
            "nameOnCardLine3": "<string>",
            "nameOnCardLine4": "<string>",
            "middleNameOnCard": "<string>"
          },
          "customAttributes": {},
          "attachments": [
            {
              "data": {
                "uri": "https://s3.amazonaws.com/dev/41963bc5feff322020137de233c3be0fac6/croppedFrontID/38d54232-b840-431d-b248-152345fe214.jpg"
              },
              "attachmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "filename": "<string>",
              "mimeType": "<string>",
              "pageNumber": 123,
              "side": "FRONT",
              "type": "<string>",
              "location": "<string>",
              "lastMalwareScanAt": "2023-11-07T05:31:56Z"
            }
          ]
        }
      ]
    },
    "name": {
      "familyName": "Doe",
      "language": "eng",
      "givenName": "John",
      "middleName": "R",
      "otherName": null,
      "prefix": "Dr.",
      "suffix": "Jr.",
      "displayName": "John Doe"
    },
    "alternateNames": [
      {
        "familyName": "Doe",
        "nameId": "87654321-4321-4321-4321-210987654321",
        "language": "eng",
        "givenName": "John",
        "middleName": "R",
        "otherName": null,
        "prefix": "Dr.",
        "suffix": "Jr.",
        "displayName": "John Doe",
        "type": "OTHER"
      }
    ],
    "dateOfBirth": {
      "year": "1990",
      "month": "03",
      "day": "27",
      "unstructured": "12 Rajab 1445 AH",
      "type": "GREGORIAN"
    },
    "alternateDatesOfBirth": [
      {
        "dateOfBirthId": "<string>",
        "year": "1990",
        "month": "03",
        "day": "27",
        "unstructured": "12 Rajab 1445 AH",
        "type": "GREGORIAN"
      }
    ],
    "gender": {
      "gender": "MALE"
    },
    "placeOfBirth": {
      "country": "USA",
      "longForm": "525 Kent Dr, Harlem NY 10037, USA",
      "unitNumber": "3A",
      "buildingName": "EQ Tower",
      "streetName": "Kent",
      "streetNumber": "525",
      "streetType": "Dr",
      "neighborhood": "Harlem",
      "locality": "Manhattan",
      "district": "New York County",
      "subdivision": "NY",
      "postalCode": "10037"
    },
    "nationality": "AUS",
    "consents": [
      {
        "type": "UNDER18"
      }
    ]
  },
  "comment": {
    "text": "Update after speaking to customer over the phone directly.",
    "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "entityType": "INDIVIDUAL"
  }
}
'
{
  "requestId": "01HN9XHZN6MGXM9JXG50K59Q85",
  "individual": {
    "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "entityType": "INDIVIDUAL",
    "createdAt": "2023-11-07T05:31:56Z",
    "schemaVersion": 2,
    "addresses": [
      {
        "country": "<string>",
        "addressId": "<string>",
        "sourceId": "<string>",
        "type": "OTHER",
        "typeDescription": "<string>",
        "validFrom": {
          "year": "1990",
          "month": "03",
          "day": "27",
          "unstructured": "12 Rajab 1445 AH",
          "type": "GREGORIAN",
          "normalized": "1990-03-31"
        },
        "validTo": {
          "year": "1990",
          "month": "03",
          "day": "27",
          "unstructured": "12 Rajab 1445 AH",
          "type": "GREGORIAN",
          "normalized": "1990-03-31"
        },
        "longForm": "<string>",
        "unitNumber": "<string>",
        "buildingName": "<string>",
        "streetName": "<string>",
        "streetNumber": "<string>",
        "streetType": "<string>",
        "neighborhood": "<string>",
        "locality": "<string>",
        "district": "<string>",
        "subdivision": "<string>",
        "postalCode": "<string>",
        "careOf": "<string>",
        "status": "CURRENT",
        "unstructuredLongForm": "<string>"
      }
    ],
    "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"
          }
        ],
        "unstructuredLongForm": "<string>"
      }
    ],
    "emailAddresses": [
      {
        "emailAddressId": "aa385f64-5717-4562-b3fc-2c963f66af21",
        "type": "WORK",
        "sourceId": "31dd15f64-5717-4562-b3fc-2c963f66234d",
        "email": "[email protected]",
        "isPreferred": true,
        "linkedAddresses": [
          {
            "addressId": "adc215f64-5717-4562-b3fc-2c963f66222a"
          }
        ]
      }
    ],
    "customAttributes": {},
    "externalReferences": [
      {
        "name": "CUSTOMER-REFERENCE",
        "value": "CUST-00001342",
        "referenceId": "24de15f64-5717-4562-b3fc-2c963f66e23e",
        "type": "CUSTOMER",
        "sourceId": "93da15f64-5717-4562-b3fc-2c963f6663fe",
        "description": "This is the customer ID in the core banking system."
      }
    ],
    "documents": {
      "REPORT": [
        {
          "type": "OTHER",
          "country": "AUS",
          "class": "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",
            "type": "GREGORIAN",
            "normalized": "1990-03-31"
          },
          "issueDate": {
            "year": "1990",
            "month": "03",
            "day": "27",
            "unstructured": "12 Rajab 1445 AH",
            "type": "GREGORIAN",
            "normalized": "1990-03-31"
          },
          "primaryIdentifier": "000734130",
          "secondaryIdentifier": "P0001975",
          "subtype": "Photo Comparison",
          "subdivision": "VIC",
          "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",
            "type": "GREGORIAN",
            "normalized": "1990-03-31"
          },
          "validTo": {
            "year": "1990",
            "month": "03",
            "day": "27",
            "unstructured": "12 Rajab 1445 AH",
            "type": "GREGORIAN",
            "normalized": "1990-03-31"
          },
          "sourceId": "324f15f64-5717-4562-b3fc-2c963f66ffa1",
          "supplementaryData": {
            "type": "NATIONAL_HEALTH_ID",
            "reference": "1",
            "nameOnCardLine1": "<string>",
            "nameOnCardLine2": "<string>",
            "nameOnCardLine3": "<string>",
            "nameOnCardLine4": "<string>",
            "middleNameOnCard": "<string>"
          },
          "customAttributes": {},
          "attachments": [
            {
              "data": {
                "uri": "https://s3.amazonaws.com/dev/41963bc5feff322020137de233c3be0fac6/croppedFrontID/38d54232-b840-431d-b248-152345fe214.jpg"
              },
              "attachmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "sourceId": "<string>",
              "createdAt": "2023-11-07T05:31:56Z",
              "updatedAt": "2023-11-07T05:31:56Z",
              "filename": "<string>",
              "mimeType": "<string>",
              "pageNumber": 123,
              "side": "FRONT",
              "type": "<string>",
              "location": "<string>",
              "lastMalwareScanAt": "2023-11-07T05:31:56Z",
              "retrievalStatus": "NORMAL"
            }
          ]
        }
      ],
      "SUPPORTING": [
        {
          "type": "OTHER",
          "country": "AUS",
          "class": "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",
            "type": "GREGORIAN",
            "normalized": "1990-03-31"
          },
          "issueDate": {
            "year": "1990",
            "month": "03",
            "day": "27",
            "unstructured": "12 Rajab 1445 AH",
            "type": "GREGORIAN",
            "normalized": "1990-03-31"
          },
          "primaryIdentifier": "000734130",
          "secondaryIdentifier": "P0001975",
          "subtype": "Photo Comparison",
          "subdivision": "VIC",
          "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",
            "type": "GREGORIAN",
            "normalized": "1990-03-31"
          },
          "validTo": {
            "year": "1990",
            "month": "03",
            "day": "27",
            "unstructured": "12 Rajab 1445 AH",
            "type": "GREGORIAN",
            "normalized": "1990-03-31"
          },
          "sourceId": "324f15f64-5717-4562-b3fc-2c963f66ffa1",
          "supplementaryData": {
            "type": "NATIONAL_HEALTH_ID",
            "reference": "1",
            "nameOnCardLine1": "<string>",
            "nameOnCardLine2": "<string>",
            "nameOnCardLine3": "<string>",
            "nameOnCardLine4": "<string>",
            "middleNameOnCard": "<string>"
          },
          "customAttributes": {},
          "attachments": [
            {
              "data": {
                "uri": "https://s3.amazonaws.com/dev/41963bc5feff322020137de233c3be0fac6/croppedFrontID/38d54232-b840-431d-b248-152345fe214.jpg"
              },
              "attachmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "sourceId": "<string>",
              "createdAt": "2023-11-07T05:31:56Z",
              "updatedAt": "2023-11-07T05:31:56Z",
              "filename": "<string>",
              "mimeType": "<string>",
              "pageNumber": 123,
              "side": "FRONT",
              "type": "<string>",
              "location": "<string>",
              "lastMalwareScanAt": "2023-11-07T05:31:56Z",
              "retrievalStatus": "NORMAL"
            }
          ]
        }
      ],
      "IDENTITY": [
        {
          "type": "OTHER",
          "country": "AUS",
          "class": "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",
            "type": "GREGORIAN",
            "normalized": "1990-03-31"
          },
          "issueDate": {
            "year": "1990",
            "month": "03",
            "day": "27",
            "unstructured": "12 Rajab 1445 AH",
            "type": "GREGORIAN",
            "normalized": "1990-03-31"
          },
          "primaryIdentifier": "000734130",
          "secondaryIdentifier": "P0001975",
          "subtype": "Photo Comparison",
          "subdivision": "VIC",
          "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",
            "type": "GREGORIAN",
            "normalized": "1990-03-31"
          },
          "validTo": {
            "year": "1990",
            "month": "03",
            "day": "27",
            "unstructured": "12 Rajab 1445 AH",
            "type": "GREGORIAN",
            "normalized": "1990-03-31"
          },
          "sourceId": "324f15f64-5717-4562-b3fc-2c963f66ffa1",
          "supplementaryData": {
            "type": "NATIONAL_HEALTH_ID",
            "reference": "1",
            "nameOnCardLine1": "<string>",
            "nameOnCardLine2": "<string>",
            "nameOnCardLine3": "<string>",
            "nameOnCardLine4": "<string>",
            "middleNameOnCard": "<string>"
          },
          "customAttributes": {},
          "attachments": [
            {
              "data": {
                "uri": "https://s3.amazonaws.com/dev/41963bc5feff322020137de233c3be0fac6/croppedFrontID/38d54232-b840-431d-b248-152345fe214.jpg"
              },
              "attachmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "sourceId": "<string>",
              "createdAt": "2023-11-07T05:31:56Z",
              "updatedAt": "2023-11-07T05:31:56Z",
              "filename": "<string>",
              "mimeType": "<string>",
              "pageNumber": 123,
              "side": "FRONT",
              "type": "<string>",
              "location": "<string>",
              "lastMalwareScanAt": "2023-11-07T05:31:56Z",
              "retrievalStatus": "NORMAL"
            }
          ]
        }
      ],
      "OTHER": [
        {
          "type": "OTHER",
          "country": "AUS",
          "class": "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",
            "type": "GREGORIAN",
            "normalized": "1990-03-31"
          },
          "issueDate": {
            "year": "1990",
            "month": "03",
            "day": "27",
            "unstructured": "12 Rajab 1445 AH",
            "type": "GREGORIAN",
            "normalized": "1990-03-31"
          },
          "primaryIdentifier": "000734130",
          "secondaryIdentifier": "P0001975",
          "subtype": "Photo Comparison",
          "subdivision": "VIC",
          "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",
            "type": "GREGORIAN",
            "normalized": "1990-03-31"
          },
          "validTo": {
            "year": "1990",
            "month": "03",
            "day": "27",
            "unstructured": "12 Rajab 1445 AH",
            "type": "GREGORIAN",
            "normalized": "1990-03-31"
          },
          "sourceId": "324f15f64-5717-4562-b3fc-2c963f66ffa1",
          "supplementaryData": {
            "type": "NATIONAL_HEALTH_ID",
            "reference": "1",
            "nameOnCardLine1": "<string>",
            "nameOnCardLine2": "<string>",
            "nameOnCardLine3": "<string>",
            "nameOnCardLine4": "<string>",
            "middleNameOnCard": "<string>"
          },
          "customAttributes": {},
          "attachments": [
            {
              "data": {
                "uri": "https://s3.amazonaws.com/dev/41963bc5feff322020137de233c3be0fac6/croppedFrontID/38d54232-b840-431d-b248-152345fe214.jpg"
              },
              "attachmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "sourceId": "<string>",
              "createdAt": "2023-11-07T05:31:56Z",
              "updatedAt": "2023-11-07T05:31:56Z",
              "filename": "<string>",
              "mimeType": "<string>",
              "pageNumber": 123,
              "side": "FRONT",
              "type": "<string>",
              "location": "<string>",
              "lastMalwareScanAt": "2023-11-07T05:31:56Z",
              "retrievalStatus": "NORMAL"
            }
          ]
        }
      ]
    },
    "sourceId": "<string>",
    "name": {
      "familyName": "Doe",
      "nameId": "87654321-4321-4321-4321-210987654321",
      "language": "eng",
      "givenName": "John",
      "middleName": "R",
      "otherName": null,
      "prefix": "Dr.",
      "suffix": "Jr.",
      "sourceId": "87654321-4321-4321-4321-210987654322",
      "displayName": "John Doe"
    },
    "alternateNames": [
      {
        "familyName": "Doe",
        "nameId": "87654321-4321-4321-4321-210987654321",
        "language": "eng",
        "givenName": "John",
        "middleName": "R",
        "otherName": null,
        "prefix": "Dr.",
        "suffix": "Jr.",
        "sourceId": "87654321-4321-4321-4321-210987654322",
        "displayName": "John Doe",
        "type": "OTHER"
      }
    ],
    "dateOfBirth": {
      "dateOfBirthId": "<string>",
      "sourceId": "<string>",
      "year": "1990",
      "month": "03",
      "day": "27",
      "unstructured": "12 Rajab 1445 AH",
      "type": "GREGORIAN",
      "normalized": "1990-03-31"
    },
    "alternateDatesOfBirth": [
      {
        "dateOfBirthId": "<string>",
        "sourceId": "<string>",
        "year": "1990",
        "month": "03",
        "day": "27",
        "unstructured": "12 Rajab 1445 AH",
        "type": "GREGORIAN",
        "normalized": "1990-03-31"
      }
    ],
    "gender": {
      "genderId": "<string>",
      "gender": "MALE",
      "sourceId": "<string>"
    },
    "placeOfBirth": {
      "country": "USA",
      "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",
      "postalCode": "10037"
    },
    "nationality": "AUS",
    "consents": [
      {
        "type": "UNDER18",
        "schemaVersion": 123,
        "sourceId": "93da15f64-5717-4562-b3fc-2c963f6663fe"
      }
    ],
    "informationSources": {},
    "relationships": {
      "duplicates": [
        {
          "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "entityType": "INDIVIDUAL",
          "origin": {
            "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "entityType": "INDIVIDUAL",
            "processResultId": "<string>",
            "createdAt": "2023-11-07T05:31:56Z"
          }
        }
      ]
    }
  },
  "serviceProfiles": [
    {
      "serviceProfileId": "55fc5d54-46f7-49c8-bf78-e07ec79c42fd",
      "latestRiskAssessmentId": "<string>",
      "latestWorkflowExecutionId": "<string>",
      "entityId": "<string>",
      "entityName": "<string>",
      "entityType": "<string>",
      "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",
      "currentWorkflowId": "<string>",
      "currentWorkflowName": "<string>",
      "workflowSummaries": [
        {
          "schemaVersion": 123,
          "workflowName": "<string>",
          "workflowExecutionId": "<string>",
          "workflowExecutionState": "COMPLETED",
          "status": "UNCHECKED",
          "statusOverrideAt": "2023-11-07T05:31:56Z",
          "statusOverrideRequestId": "<string>",
          "statusOverrideBy": "<string>",
          "riskAssessment": {
            "serviceProfileId": "<string>",
            "workflowId": "<string>",
            "workflowExecutionId": "<string>",
            "entityId": "<string>",
            "riskAssessmentId": "<string>",
            "schemaVersion": 123,
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z",
            "updatedBy": "<string>",
            "updatedRequestId": "<string>",
            "workflowRiskScore": 123,
            "workflowRiskLevel": "UNKNOWN",
            "riskScore": 123,
            "riskLevel": "UNKNOWN",
            "isOutdated": false,
            "riskFactors": [
              {
                "riskFactorId": "<string>",
                "factor": "<string>",
                "value": "<string>",
                "score": 123,
                "description": "<string>",
                "workflowExecutionId": "<string>",
                "stepResultId": "<string>",
                "manualOverrideScore": 123,
                "status": "VALID",
                "createdAt": "2023-11-07T05:31:56Z",
                "updatedAt": "2023-11-07T05:31:56Z",
                "updatedBy": "<string>",
                "updatedRequestId": "<string>",
                "createdServiceProfileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "createdWorkflowExecutionId": "<string>",
                "createdStepResultId": "<string>"
              }
            ]
          },
          "isManual": true,
          "steps": {
            "order": [
              "<string>"
            ],
            "passed": [
              "<string>"
            ],
            "failed": [
              "<string>"
            ],
            "incomplete": [
              "<string>"
            ],
            "notApplicable": [
              "<string>"
            ]
          },
          "startedAt": "2023-11-07T05:31:56Z",
          "endedAt": "2023-11-07T05:31:56Z",
          "issues": [
            {
              "category": "AML",
              "issue": "AML_ISSUE",
              "severity": "INFO",
              "issueId": "<string>",
              "workflowExecutionId": "<string>",
              "stepResultId": "<string>",
              "isCleared": true,
              "createdBy": "<string>",
              "createdAt": "2023-11-07T05:31:56Z",
              "updatedAt": "2023-11-07T05:31:56Z",
              "updatedBy": "<string>",
              "updatedRequestId": "<string>"
            }
          ],
          "lifecyclePhase": "OTHER",
          "monitoringTypes": [
            "AML"
          ]
        }
      ],
      "serviceName": "<string>",
      "customerReference": "<string>",
      "subscriptions": [
        {
          "serviceProfileId": "<string>",
          "status": "ENABLED",
          "type": "AML",
          "workflowName": "<string>",
          "workflowId": "<string>",
          "enabledAt": "2023-11-07T05:31:56Z",
          "enabledRequestId": "<string>",
          "enabledBy": "<string>",
          "disabledAt": "2023-11-07T05:31:56Z",
          "disabledRequestId": "<string>",
          "disabledBy": "<string>"
        }
      ],
      "state": "INIT"
    }
  ]
}

Authorizations

​
api_key
string
header
required

Headers

​
api_key
string
required

Your API key provided by FrankieOne

Example:

"245c765b124a098d09ef8765...."

​
X-Frankie-CustomerID
string
required

Your Customer ID provided by FrankieOne

Example:

"12345678-1234-1234-1234-123456789012"

​
X-Frankie-CustomerChildID
string

Your Customer Child ID provided by FrankieOne

Example:

"87654321-4321-4321-4321-210987654321"

​
X-Frankie-Channel
string

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-Username
string

Username provided by API caller

Example:

"[email protected]"

Path Parameters

​
entityId
string
required

Unique FrankieOne identifier for an entity

Query Parameters

​
level
enum<string>
default:meta

Determines what level of detail to return in the response

  • meta: Return all metadata only, no links or base64 data
  • base64: Return all metadata and images as base64
Available options:
meta,
base64

Body

application/json
​
individual
object
​
comment
object

Response

OK

​
requestId
string
required

The unique request identifier for the API call made.

Example:

"01HN9XHZN6MGXM9JXG50K59Q85"

​
individual
object
​
serviceProfiles
object[]