Individual Module

Quick Implementation

Initialize the Module

// Create an instance of the Individual module
const individual = oneSdk.individual();

// Add required user consent
individual.addConsent("general");

Core Methods

Access User Properties

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

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

// Example: Setting user name properties
setValue({
    givenName: 'Albert',
    familyName: 'Einstein',
    middleName: 'J',
    displayName: 'Albert Einstein',
});

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

// Add user consent programmatically
individual.addConsent("general");
individual.addConsent("docs");
individual.addConsent("creditheader");

Always capture user consent before calling submit() or verify().

To read more about consent management, read more here.

Document Management

Add Document
Update Document

const document = {
  documentId: "doc123",
  idType: "PASSPORT",
  country: "AUS",
  idNumber: "P123456",
  idExpiry: "2025-12-31"
};

individual.addDocument(document);

individual.updateDocument("doc123", {
  idExpiry: "2026-12-31"
});

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

individual.addAddress({
    addressType: 'RESIDENTIAL',
    buildingName: 'Noida',
    country: 'AUS',
    postalCode: '224400',
    state: 'ACT',
    streetName: 'Mock Street',
    streetNumber: '123',
    town: 'Mock town/suburb',
    unitNumber: '1',
});

individual.updateAddress("address-123", {
  postalCode: "224401",
  streetName: "New Street",
});

Profile Management

Set Profile Type

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)

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

Set Contact Information

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

Submit Profile

await individual.submit();

// to submit profile and run check
await individual.submit({ verify: true });

Run Check

// to only run check to entity without submitting
await individual.runCheck();

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

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

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

OneSDK

Smart UI (for deprecation)

Quick Implementation

Core Methods

Document Management

Identity Documents

Proof Documents

Address Management

Profile Management

Standard

Enhanced

Specialized

Add Extra KVP

​Quick Implementation

​Core Methods

​Document Management

Identity Documents

Proof Documents

​Address Management

​Profile Management

Standard

Enhanced

Specialized

​Add Extra KVP

Quick Implementation

Core Methods

Document Management

Address Management

Profile Management

Add Extra KVP