Facebook AccountKit JS SDK

(Unofficial) Not affiliated with Facebook. An SDK for the AccountKit Client Access Token Flow so it directly returns a user Access Token

Tested and in use. Subject to change without notice.

Install

npm install fbaccountkit --save

Usage

Initialise

const AccountKit = require('fbaccountkit');

const accountkit = new AccountKit(ACCOUNTKIT_APP_ID, ACCOUNTKIT_CLIENT_TOKEN);

Validate the Access Token

accountkit.validate(userAccessToken, userAccountKitId)

Params (all required)

| Name | Type | Description | | --- | --- | --- | | userAccessToken | string| The Access Token of a user verify | | userAccountKitId | string| The AccountKit ID of the user |

Returns

Returns a promise that resolves with true if valid and false otherwise

Start Login

accountkit.startLogin(credentialsType, locale, phoneNumber, sdk, responseType)

Params (all required)

| Name | Type | Description | | --- | --- | --- | | credentialsType | string| Indicates what type of login the user initiated. Can be one of: * phone_number * email| | locale | string| The language of the sms text. By default we en_GB, visit https://developers.facebook.com/docs/messenger-platform/messenger-profile/supported-locales/ to see other locale options| | phoneNumber | string| The number the sms will be sent to. It is formed by the concatenation of country code 44 and number 7853189469. Example: 447853189469| | sdk | string| The sdk the endpoint is depending on. Can be one of: * android * ios| | responseType | string| The response type of the call. Can be one of: * code if client access token flow is turned on. * token if it's turned off (by default it is) |

Returns

Returns a promise that resolves with the accountkit response (as shown below) if successful and false otherwise or throws an error if one occurred

{
   expires_in_sec: 600,
   login_request_code: "9d9cft9a7g2b9as63fd83074338e133f",
   min_resend_interval_sec: 120,
   status: "pending",
   privacy_policy: "",
   terms_of_service: ""
}

Confirm Login

accountkit.confirmLogin(credentialsType, locale, confirmationCode, loginRequestCode, phoneNumber, sdk, responseType)

Params (all required)

| Name | Type | Description | | --- | --- | --- | | credentialsType | string| Indicates what type of login the user initiated. Can be one of: * phone_number * email| | locale | string| The language of the sms text. By default en_GB, visit https://developers.facebook.com/docs/messenger-platform/messenger-profile/supported-locales/ to see other locale options| | confirmationCode | string| A 6 digits code sent in the sms message to match with login_request_code. The user must provide this. Example: 965269| | loginRequestCode | string| The result returned by start_login call, this is encoded in account kit format and will be used to match with confirmation_code provided by the user. Example: 9d9cft9a7g2b9as63fd83074338e133f| | phoneNumber | string| The number the sms will be sent to. It is formed by the concatenation of country code 44 and number 7853189469. Example: 447853189469| | sdk | string| The sdk the endpoint is depending on. Can be one of: * android * ios| | responseType | string| The response type of the call. Can be one of: * code if client access token flow is turned on. * token if it's turned off (by default it is) |

Returns

Returns a promise that resolves with the accountkit response (as shown below) if successful and false otherwise or throws an error if one occurred

{
   access_token: "EASWefw7wSTYT3fd83074tyPCS5ZAKbTfDfQ5tPMG10Y3H8zAFwZDGO",
   id: "2471288196469693",
   state: "",
   status: "completed",
   token_refresh_interval_sec: 2592000
}

License

MIT (see LICENSE file)

Neither endorsed by nor affiliated with Facebook