Individual Module

Quick Implementation

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

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

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

Document Management

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);

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

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

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

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

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

Advanced Use Case for Submit and Executing Specific Workflow

By default, OneSDK with v2 API have an “assigned” workflow on compile-time, meaning our representative will set a specific workflow to run against when you run a individual.submit({ verify: true }) or individual.runCheck() However, if you desire to have a more advanced use case where you want to trigger a specific workflow instead, you can

1
// finish all the KYC process, save all the entity progress
2
await individual.submit();
3
4
// execute specific workflow you want
5
await fetch('https://api.uat.frankie.one/v2/individuals/:entityId/serviceprofiles/:serviceName/workflows/:workflowName/execute', {
6
  method: 'POST'
7
});

To read more about executing workflow, go to this page.

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

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