Individual Module | FrankieOne

Quick Implementation

Initialize the Module

1 // Create an instance of the Individual module
2 const individual = oneSdk.individual();
3 
4 // Add required user consent
5 individual.addConsent("general");

Core Methods

Access User Properties

Use individual.access() to manage core user properties:

1 const { setValue, getValue } = individual.access('name');
2 
3 // Example: Setting user name properties
4 setValue({
5     givenName: 'Albert',
6     familyName: 'Einstein',
7     middleName: 'J',
8     displayName: 'Albert Einstein',
9 });

By using setValue() method on individual module, you are adding details on an entity, that will get pre-filled on your eKYC Form module.

Available properties:

Property	Description
`addresses`	User’s addresses. See Address Properties table below
`dateOfBirth`	User’s date of birth
`documents`	Identity documents
`email`	Contact email address
`entityId`	user’s entityId (Note: there’s no `setValue` on this property)
`name`	User’s name information
`phoneNumber`	Contact phone number
`profile`	User profile details

Address Properties:

Property	Description
`addressType`	RESIDENTIAL1 for primary address; RESIDENTIAL2 for additional address
`buildingName`	Building name
`country`	User’s country in ISO 3166-1 alpha-3 format
`longForm`	User’s long form address - Only fill this data if you do not have broken down address - Make sure to fill out `data.longForm` along with `longForm - The address will be broken down by FrankieOne system upon running checks
`postal`	Postal address
`state`	User’s state
`streetName`	User’s street name
`streetNumber`	User’s street number
`streetType`	User’s street type, for example, *Road, St., Ave, Circuit, and others
`suburb`	User’s suburb
`unitNumber`	User’s unit number

Document Management

Add Document

Update Document

1 const document = {
2   documentId: "doc123",
3   idType: "PASSPORT",
4   country: "AUS",
5   idNumber: "P123456",
6   idExpiry: "2025-12-31"
7 };
8 
9 individual.addDocument(document);

Document Types

Identity Documents

PASSPORT
DRIVERS_LICENCE
NATIONAL_ID
MILITARY_ID

Proof Documents

UTILITY_BILL
BANK_STATEMENT
PROOF_OF_ADDRESS
TAX_STATEMENT

To read more about document types, go here.

Address Management

1 individual.addAddress({
2     addressType: 'RESIDENTIAL',
3     buildingName: 'Noida',
4     country: 'AUS',
5     postalCode: '224400',
6     state: 'ACT',
7     streetName: 'Mock Street',
8     streetNumber: '123',
9     suburb: 'Mock suburb',
10     unitNumber: '1',
11 });

Profile Management

Set Profile Type

1 individual.setProfileType('standard_kyc');

Available Profile Types

Standard

standard_kyc
gov_id
safe_harbour

Enhanced

international
safe_harbour_plus
full

Specialized

under18
devicecheck
aml_only

Add Reference (Optional)

1 individual.addReference("customer-id", "REF123");

Set Contact Information

1 individual.setPhoneNumber("+61412345678");
2 individual.setEmail("user@example.com");

Submit Profile

1 await individual.submit();

Add Extra KVP

If you want to set an additional KVPs to an entity, you can use .setExtraData Read more about KVP here. .setExtraData accepts an object with key of string and value of string

Setting up KVPs

1 individual.setExtraData({
2   key: 'value',
3   extraInformation: 'foo-bar'
4 })

Best Practice

Always validate required fields and ensure user consent is captured before submitting the profile.

1	// Add user consent programmatically
2	individual.addConsent("general");
3	individual.addConsent("docs");
4	individual.addConsent("creditheader");