KYC API EndpointsEntity

Update Existing Entity

Using a previously uploaded but incomplete Entity, you can optionally supply updated details (such as corrections on a previous address), along with one or more additional ID docs/scans (e.g. new documents to parse, etc).

Path parameters

entityIdstringRequiredformat: "uuid"

The entityId returned previously from an earlier call to /check or /entity

Headers

api_keystringRequired
X-Frankie-CustomerIDstringRequiredformat: "uuid"
Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time.
X-Frankie-CustomerChildIDstringOptionalformat: "uuid"
If, as a Frankie Customer, you are acting on behalf of your own customers, then you can populate this field with a Frankie-assigned ID. Note: If using a CustomerChildID, you will also need a separate api_key for each child. Any documents, checks, entities that are created when this field has been populated will now be tied to this CustomerID + CustomerChildID combination. Just as Customers cannot see data created by other Customers, so too a Customer's Children will not be able to see each other's data. A Customer can see the documents/entities and checks of all their Children.
X-Frankie-BackgroundintegerOptional>=0<=1
If this header parameter is supplied and set to 1, then the request will not wait for the process to finish, and will return a 202 if there are no obvious errors in the input. The request will then run in the background and send a notification back to the customer. See out callback API for details on this. See more details here: https://docs.frankieone.com/docs/asynchronous-calls-backgrounding-processes
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.

Query parameters

noInvalidatebooleanOptional
Disable check result invalidation for this update request.

Request

The entity to be updated
addresseslist of objectsOptional
Collection of address objects.
dateOfBirthobjectOptional
entityIdstringOptionalformat: "uuid"

When an entity is first created, it is assigned an ID. When updating an entity, make sure you set the entityId One exception to this is when an entity is created from a document object. It is expected that this object would be passed into a /check or /entity call to set it.

entityProfilestringOptional

If the entity is using the new profiles feature, then their profile name will be found here.

Note: If setting a profile, you must ensure that the profile matches a known configuration.

See here for valid values: https://docs.frankieone.com/docs/test-entity-verification

entityTypeenumOptional
Indicates the type of an entity. - "INDIVIDUAL": An individual. - "TRUST": A trust. - "ORGANISATION": An organisation.
Allowed values:
extraDatalist of objectsOptional
Set of key-value pairs that provide arbitrary additional type-specific data. You can use these fields to store external IDs, or other non-identity related items if you need to. If updating an existing entity, then existing values with the same name will be overwritten. New values will be added. See here for more information about possible values you can use: https://docs.frankieone.com/docs/key-value-pairs
flagslist of objectsOptional

Used to set additional information flags with regards to this entity and for ongoing processing.

Flags might include having the entity (not) participate in regular pep/sanctions screening Others will follow over time.

genderenumOptional
Used to indicate of the entity in question is: - "M"ale - "F"emale - "U"nspecified - "O"ther (for want of a better option)
Allowed values:
identityDocslist of objectsOptional

Collection of identity documents (photos, scans, selfies, etc)

nameobjectOptional
organisationDataobjectOptional
Organisation details for entities. Returned from an ASIC report.

Response

The request was valid and able to be processed in some fashion. Results may or may not be successful, but it was completed as far as practical with no actual errors. Returns the entity object as it stands now. No docScan file data from any attached ID documents will be returned unless the /full variant is requested.
entityobject
Describes all of the data being used to verify an entity.
requestIdstringformat: "ulid"

Unique identifier for every request. Can be used for tracking down answers with technical support.

Uses the ULID format (a time-based, sortable UUID)

Note: this will be different for every request.

Errors