@nfid/credentials v1.1.3

Credentials SDK

The credentials SDK exposes typescript methods to authenticate user credentials via a window to NFID which returns zero knowledge proofs to your application.

requestPhoneNumberCredential (identity: DelegationIdentity, conf?: CredentialProviderConf) : Promise<CredentialResult>

Verify that the user has a phone number associated with their account.

Params

identity: DelegationIdentity

• The currently connected NFID identity.

conf?: CredentialProviderConf

• provider?: URL url of the credential provider, defaults to https://nfid.one/credential
• windowFeatures string or object describing the popup window for the provider

Returns

CredentialResult

• status: "SUCCESS" | "REJECTED" | "ERROR" indicates the result of the credential request. SUCCESS indicates the credential exists and you can proceed with verification. REJECTED indicates that the user has declined the request for a credential. ERROR indicates that something went wrong.
• message?: string In the case of a rejection or an error, additional details will be provided here.

Note The credential should be validated with our blackhole canister.

Client Example

Requesting a Credential

Requesting a phone number credential is as simple as:

import { requestPhoneNumberCredential } from '@nfid/credentials';

const result = await requestPhoneNumberCredential();

Verifying a Credential

It is possible for a bad actor to attempt to manipulate credentials, so we need a trustable method for verifying a them. This is provided by the is_phone_number_approved method on our blackholed "verifier" canister. Including this verification step, the complete flow would look like this:

sequenceDiagram
    participant Your App
    participant Your App (BE)
    participant NFID Frontend
    participant Verifier

    Your App->>NFID Frontend: requestPhoneNumberCredential(identity)
    note over NFID Frontend: ...Credential Flow...
    NFID Frontend->>Your App: Credential
    Your App->>Your App (BE): verifyPhoneNumberCredential(principal)
    Your App (BE)->>Verifier: is_phone_number_approved(principal)
    Verifier->>Your App (BE): bool

The full interface for this method is is_phone_number_approved(principal: string) : bool, and the canister id on mainnet is sgk26-7yaaa-aaaan-qaovq-cai.

dfx canister --network ic call sgk26-7yaaa-aaaan-qaovq-cai is_phone_number_approved '("principal-as-string")'