Skip to main content

​
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

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:
PropertyDescription
addressesUser’s addresses. See Address Properties table below
dateOfBirthUser’s date of birth
documentsIdentity documents
emailContact email address
entityIduser’s entityId (Note: there’s no setValue on this property)
nameUser’s name information
phoneNumberContact phone number
profileUser profile details
Address Properties:
PropertyDescription
addressTypeRESIDENTIAL1 for primary address; RESIDENTIAL2 for additional address
buildingNameBuilding name
countryUser’s country in ISO 3166-1 alpha-3 format
longFormUser’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
postalPostal address
stateUser’s state
streetNameUser’s street name
streetNumberUser’s street number
streetTypeUser’s street type, for example, *Road, St., Ave, Circuit, and others
suburbUser’s suburb
unitNumberUser’s unit number

​
Document Management

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

individual.addDocument(document);

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',
});

​
Profile Management

1

Set Profile Type

individual.setProfileType('standard_kyc');

Standard

  • standard_kyc
  • gov_id
  • safe_harbour

Enhanced

  • international
  • safe_harbour_plus
  • full

Specialized

  • under18
  • devicecheck
  • aml_only
2

Add Reference (Optional)

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

Set Contact Information

individual.setPhoneNumber("+61412345678");
individual.setEmail("[email protected]");
4

Submit Profile

await individual.submit();

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

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.