FrankieOne customers can use OneSDK for their KYC requirements. OneSDK replaces the need for customers to work with multiple service providers by creating an interface for integrating with different vendors consistently.

The following sections will help you setup OneSDK for your KYC implementation needs.

Capturing details from an individual

Each instance of OneSDK is initialized with a session that is associated with the user being onboarded. The user may already be represented by an Entity object in the FrankieOne platform, or it may be a new user that isn't known to FrankieOne yet. When initializing OneSDK with an existing entity, OneSDK will load any information that was previously submitted, allowing you to build continuous application experiences across multiple user sessions.

Initialize OneSDK for a new user

For onboarding a new user, you can allocate a unique customer reference when creating a session object. This customer reference will be linked to the new entity created on the FrankieOne platform.

The following example creates a session object for a user using a customer reference.

ENCODED_CREDENTIAL=$(echo -ne "$YOUR_CUSTOMER_ID:$API_KEY" | base64);

curl https://backend.demo.frankiefinancial.io/auth/v2/machine-session \
  -X POST \
  -H "Authorization: machine $ENCODED_CREDENTIAL"
  -H 'Content-Type: application/json' \
  -d '{
    "permissions": {
      "preset": "one-sdk",
      "reference": "YOUR_CUSTOMER_REFERENCE",
    }
  }';

Initialize OneSDK for an existing user

You can also create an entity in FrankieOne upfront, and use the entity ID to create the session.

ENCODED_CREDENTIAL=$(echo -ne "$YOUR_CUSTOMER_ID:$API_KEY" | base64);

curl https://backend.demo.frankiefinancial.io/auth/v2/machine-session \
  -X POST \
  -H "Authorization: machine $ENCODED_CREDENTIAL"
  -H 'Content-Type: application/json' \
  -d '{
    "permissions": {
      "preset": "one-sdk",
      "entityId": "ENTITY_ID_FROM_FRANKIE_ONE",
    }
  }';

Access the user's information

Obtain the individual object from the OneSDK instance you initialised.

const config = { 
  dummy: true // remove this in production
}
const oneSdk = await OneSdk(config);
const individual = oneSdk.individual();

Personal information about the user can be accessed using the access(fieldName) method. This method returns a handler to get access to the given field.

Get and set values

You can obtain a getter and setter for each field using the individual.access(fieldName) method.

The following example obtains the name field getter and setter, then updates the values.

const { getValue, setValue } = individual.access('name');

// Get the current values
const { givenName, familyName } = getValue()

// Update the user with new values
setValue({
  givenName: "Albert",
  familyName: "Einstein",
  middleName: "J" 
})

Add or update the address

To add or update an address in the individual object, use the following format:

// To add a new address  
const individual = onesdk.individual();  
individual.addAddress({addressType: "RESIDENTIAL", buildingName: new Date().toISOString(), country: "AUS" })

// To add multiple addresses  
individual.addAddress({addressType: "RESIDENTIAL", buildingName: new Date().toISOString(), country: "CAN" })  
individual.addAddress({addressType: "RESIDENTIAL", buildingName: new Date().toISOString(), country: "SGP" })

// To update an address: (addressId, address)  
const { getValue, setValue } = individual.access('addresses');  
const addresses = getValue()  
const { addressId } = addresses[0]  
individual.updateAddress(addressId, {addressType: "RESIDENTIAL", buildingName: new Date().toISOString(), country: "USA" })

Note that the address object has many fields that users can set: those shown above are just a sample set. You can find the complete list below:

{  
  buildingName: string;  
  postalCode: string;  
  state: string;  
  streetName: string;  
  streetNumber: string;  
  streetType: string;  
  suburb: string;  
  town: string;  
  unitNumber: string;  
  addressType: "OTHER"  
  | "RESIDENTIAL"  
  | "RESIDENTIAL1"  
  | "RESIDENTIAL2"  
  | "RESIDENTIAL3"  
  | "RESIDENTIAL4"  
  | "BUSINESS"  
  | "POSTAL"  
  | "REGISTERED_OFFICE"  
  | "PLACE_OF_BUSINESS"  
  | "PLACE_OF_BIRTH"  
  | "OFFICIAL_CORRESPONDANCE";  
  country: string;  
  longForm: string;  
}

Subscribe to changes

The access(fieldName) method also returns an RXJS.Observable object that allows you to subscribe to changes to the field's value for building reactive applications.

const { observable } = individual.access("name");
observable.subscribe(newName => {
  // update your interface with the new value
});

All fields

The supported fields you can get access to are:

Address object:

Document object:

OCRResult object:

The OCRResult object contains the data extracted from a document image. It includes fixed and variable properties depending on the extracted data.

Fixed properties:

Variable properties:

The OCRResult object will vary based on what was extracted. For example:

{
  ...,
    
  documentTypeInternal: "DRIVERS_LICENCE",  
  dateOfExpiry: "2031-05-28",  
  dateOfIssue: "2021-05-28",  
  documentType: "DRIVERS_LICENCE",  
  documentNumber: "999999999",  
  dateOfBirth: "1990-01-01",  
  issuingCountry: "AUS",  
  state: "VIC",  
  postcode: "3000",  
  town: "Melbourne",  
  street: "80 Collins Street",  
  firstName: "PETER",  
  lastName: "TESTTHIRTEEN",  
}

The Scan object:

The Scan object represents the scan details of the captured document.

Submit changes to an individual's details

When you update the details of an individual using OneSDK, the changes are stored locally but are not submitted automatically.

Use the submit() method to persist the details in the FrankieOne platform.

await individual.submit();

Verify an individual

📘

Note

Make sure you have captured consent from user before submit and verify. You would need to add consent to the individual object as follows:

JavaScript

individual.addConsent("general");
individual.addConsent("docs");
individual.addConsent("creditheader");

You may also request checks to be run with the optional parameter { verify: true }. The submit method will return a CheckSummary object in this case.

const checkResults = await individual.submit({
  verify: true
});

The CheckSummary object

This object contains the results of different checks. More complete details can be retrieved via direct API calls.

The Issue object

The issue object represents an issue found during the entity verification process.