@payrail/ancore NPM

Ancore Cloud Framework

Import the SDK to your application

import { AncoreClient,  UriPath, OAuthCredential,Misc} from '@payrail/ancore'

const client = new AncoreClient( new UriPath('https://d30j1fl4d3p9wd.cloudfront.net'));

To perform user onboarding

<!-- * Call to onboard an account
* @param options : the onboard params.
* @returns a promise to the onboarding status.
* @technote The onboarding process occurs in phases;
*  - Pass in the options with email or phone number field. (This will be passed at every phase of the onboarding process)
*  - On response status of `verify` display 2fa UI and add the input in options.mfa
*  - On response status of `processing` display kyc form and add the input to options.accountProvisionSettings
*  - On response status of `complete` or `verified` display success take to sign-in ui.
*  End

* Call handleOnboardingStatus function to receive onboarding status event -->

  client.handleOnboardingStatus = (evt) => {
      <!-- * Perform any other implementation you want to do -->
      }

      <!-- * Define function that object of a user with email or phone number
      * @param {email | phone} payload  -->

      await client.onboarding(payload);

To perform user mfa verification

 <!-- * Call the onboarding function to validate the user mfa to the account
 * Define the function to verify OTP code sent to user email or phone number
 * @param {email | phone, mfa} payload 
 * @returns Success object 
 *  - On response status of `processing` display kyc form and add the input to options.accountProvisionSettings
* Call handleOnboardingStatus function to receive onboarding status event -->

  client.handleOnboardingStatus = (evt) => {
        <!-- * Perform any other implementation you want to do -->
      }
 <!-- * Define function that object of a user with email or phone number and mfa code -->
  await client.onboarding(payload);

To perform bvn validation

<!-- * Call the onboarding function to validate the user bvn to the account
* @param options: the onboard params.
* @returns a promise to the onboarding status.
* @technote The onboarding process occurs in phases;
*  - Pass in the options with email or phone number field. (This will be passed at every phase of the onboarding process)
*  - On response status of `verify` display 2fa UI and add the input in options.mfa
*  - On response status of `processing` display kyc form and add the input to options.accountProvisionSettings
*  - On response status of `complete` or `verified` display success take to sign-in ui.
*  End
   * Call handleOnboardingStatus function to receive onboarding status event -->

  client.handleOnboardingStatus = (evt) => {
         <!-- * Perform any other implementation you want to do -->
      }

      <!-- * Define function that object of a user with email or phone number
      * @param {email | phone, mfa, bvn} payload  -->
      
      await client.onboarding(payload);

To perform user identity onboarding

    <!-- * Call the onboarding function to perform the user identity
    * @param options: the onboard params.
    * @returns a promise to the onboarding status.
    * @technote The onboarding process occurs in phases;
    *  - Pass in the options with email or phone number field. (This will be passed at every phase of the onboarding process)
    *  - On response status of `verify` display 2fa UI and add the input in options.mfa
    *  - On response status of `processing` display kyc form and add the input to options.accountProvisionSettings
    *  - On response status of `complete` or `verified` display success take to sign-in ui.
    *  End

    * Call handleOnboardingStatus function to receive onboarding status event -->

    client.handleOnboardingStatus = (evt) => {
             <!-- * Perform any other implementation you want to do -->
        }

        <!-- * Define function that object of a user with email or phone number
        * @param -->

        const payload = {email | phone, mfa, kyc:{
            bvn,
            firstname,
            lastname
        },
            accountProvisionSettings: {
            subscriber_account_name: payload.subscriber_account_name,
            subscriber_data_security_mode: 'system',
            subscriber_dataprotection_algo: 'none',
            administratorCredentials: new OAuthCredential(
                Misc.GenerateId(Misc.Constants.MAX_ID_LENGTH),
                Misc.GenerateId(Misc.Constants.MAX_ID_LENGTH),
                {email | phone},
                password,
                false,
            ).serialize(SerializeFormats.HIBERNATESTATE_FORMAT)
        } }  
        
        await client.onboarding(payload);

To perform user authentication

<!-- * Call to authenticate credentials in exchange for a Session on the platform.
* This uses an Oauth style architecture.
* @param username : the authentication credentials username.
* @param secret : the authentication credentials secret.
* @param options : the optional platform subscriber info that must be passed with the subscriber's UUID hash.
* @returns a promise to a service telegram response from the endpoint.
* The handleMfaRequired function needs to be called before the authenticate method, the method got triggered if 2FA is required. -->

 client.handleMfaRequired = (evt) => {
        <!-- * Perform any other implementation you want to do -->
      }
<!-- * This authenticate function returned a session object if no 2FA is required -->
     const session = await client.authenticate(username,
      secret,
        {
            uuidHash: uuidHash
        }
    );

To perform user authentication

 <!-- * Define the function to verify 2FA code sent to user email or phone number
* @param username : the authentication credentials username.
* @param secret : the authentication credentials secret.
* @param options : the optional platform subscriber info that must be passed with the subscriber's UUID hash.
* @returns a promise to a service telegram response from the endpoint.
 
* This authenticate function returned a session object if no 2FA is required -->
     const session = await client.authenticate(username,
      secret,
        {
            uuidHash: uuidHash
            mfa: mfa,
            signinResponse: signinResponse
        }
    );

Call to perform user signout

   <!-- * Call to signout session
   * @returns true if signout was successful. -->

        await client.signout();

Call to get user account information

  <!-- * Call to get information of the active Session's account.
  * @returns the active/last Session's account information. -->

    await client.accountinfo();

To get the information (which is the AccountInfo interface in the SDK source code) of the account after an onboarding success response or after a session is received during the sign-in process.

client.accountInfo()

To get the amount of time (in seconds) the server is requesting the client to hold-on before trying to request another OTP.

client.waitTime()

To get the last message that was sent to the client from the server during the onboarding process.

client.message()

You can also handle Account ID missing from client cache by listening/registering for event handler and display the Account ID input field only when it's not available.