KYC API EndpointsEntity

Update Entity and Get IDV Token

Update an entity object and if successful, obtain a token for use in an ID Validation service SDK (web or native app) At a minimum, the entity will need to have a name. For best results, you should gather the DoB, address, ID document details as well before calling the initProcess function. SPECIAL NOTE 1: Tokens have a limited lifespan, typically only 1 hour. Make sure you've used it or you will need to create another using update version of this function. SPECIAL NOTE 2: This function will need to be followed up with a call to /entity/{id}/idvalidate/initProcess once you've collected all your data in your app/web capture process.

Authentication

api_keystring
API Key authentication via header

Path parameters

entityIdstringRequiredformat: "uuid"

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

Headers

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-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.

Request

The entity to update and required data to generate an IDV token
entityobjectRequired
Describes all of the data being used to verify an entity.
applicantIdstringOptional

The applicantId previously supplied when creating a token for the first time for an entity. Only required if re-submitting for a fresh token on a previously created applicant.

applicationIdstringOptional

If this is for a native application SDK, then we need the applicationId as reported by the SDK. This will then be tied to the token so it cannot be used in another application or handset.

You must send either an applicationID or a referrer (see below)

referrerstringOptional

If this is for a web SDK, then you need to supply the referrer domain so that the token can be validated by the IDV service

You must send either a referrer or an applicationID (see above)

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.

Also returned is the applicantId and token to be in the IDV process.

applicantIdstring
The applicantId is either the same one that was supplied in the request for a fresh token, or a new one. This ID must be supplied along with the token to your SDK so that it knows who any uploaded documents are for. The latest applicant will also be written to the extraData of the entity as well for safe keeping. Older applicantIds will be overwritten.
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.

tokenstring

Token to be used in the SDK to authenticate the applicant and application/referrer.

Tokens are time limited (1 hour) and can only be used with the applicantId supplied.

supportTwoDocsboolean or null
If the requesting customer can support requesting 2 documents.

Errors