kyc-js-sdk

    1.1.0 • Public • Published

    MobID KYC JS SDK

    MobidKycApi - JavaScript client for MobID KYC API API for MOBID KYC APP This SDK is generated by the Swagger Codegen project:

    • API version: v1.1
    • Package version: v1.1

    Installation

    npm

    npm install mobid_kyc_api --save

    Getting Started

    Example SDK usage:

    var MobidKycApi = require('mobid_kyc_api');
    
    var defaultClient = MobidKycApi.ApiClient.instance;
    
    // Set the API host, default is http://127.0.0.1:8000
    defaultClient.basePath = 'https://api.mobid.ai'
    
    
    const getBearerTokenAndCallAPI = (ApiClient) => {
      let auth = new MobidKycApi.ApiTokenAuthApi(defaultClient)
    
      const authData = {
        username: 'CLIENT_ID',
        password: 'CLIENT_SECRET'
      }
      const authCallback = function(error, data, response) {
        if (error) {
          console.error(error);
          return null;
        } else {
          console.log('API called successfully. Returned token: ' + data.token);
    
          let apiKey = data.token;
    
          callAPI(apiKey);
        }
      };
      auth.apiTokenAuthCreate(authData, authCallback)
    
    }
    
      const callAPI = (apiKey) => {
    
    
      // Configure API key authorization: Bearer
      let Bearer = defaultClient.authentications['Bearer'];
      Bearer.name = 'Authorization'
      Bearer.apiKey = apiKey
      // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
      Bearer.apiKeyPrefix = "Bearer"
    
      let api = new MobidKycApi.ApiApi()
    
      let data = new MobidKycApi.ConferenceUpdate(); // {ConferenceUpdate}
      data.verification = 'verification UUID'
    
      const callback = function(error, data, response) {
        if (error) {
          console.error(error);
        } else {
          console.log('API called successfully. Returned data: ' + data);
        }
      };
      api.apiV11ConferencesCreate(data, callback);
    }
    
    
    getBearerTokenAndCallAPI(defaultClient)

    w

    Documentation for API Endpoints

    All URIs are relative to http://127.0.0.1:8000

    Class Method HTTP request Description
    MobidKycApi.ApiApi apiV11ConferencesCreate POST /api/v1.1/conferences/
    MobidKycApi.ApiApi apiV11ConferencesList GET /api/v1.1/conferences/
    MobidKycApi.ApiApi apiV11ConferencesPartialUpdate PATCH /api/v1.1/conferences/{conference_id}/
    MobidKycApi.ApiApi apiV11ConferencesRead GET /api/v1.1/conferences/{conference_id}/
    MobidKycApi.ApiApi apiV11ConferencesUpdate PUT /api/v1.1/conferences/{conference_id}/
    MobidKycApi.ApiApi apiV11ImagesCreate POST /api/v1.1/images/
    MobidKycApi.ApiApi apiV11ImagesList GET /api/v1.1/images/
    MobidKycApi.ApiApi apiV11ImagesPartialUpdate PATCH /api/v1.1/images/{image_id}/
    MobidKycApi.ApiApi apiV11ImagesRead GET /api/v1.1/images/{image_id}/
    MobidKycApi.ApiApi apiV11ImagesUpdate PUT /api/v1.1/images/{image_id}/
    MobidKycApi.ApiApi apiV11VerificationsCreate POST /api/v1.1/verifications/
    MobidKycApi.ApiApi apiV11VerificationsImagesCreate POST /api/v1.1/verifications/{verification_id}/images/
    MobidKycApi.ApiApi apiV11VerificationsImagesList GET /api/v1.1/verifications/{verification_id}/images/
    MobidKycApi.ApiApi apiV11VerificationsImagesPartialUpdate PATCH /api/v1.1/verifications/{verification_id}/images/{image_id}/
    MobidKycApi.ApiApi apiV11VerificationsImagesRead GET /api/v1.1/verifications/{verification_id}/images/{image_id}/
    MobidKycApi.ApiApi apiV11VerificationsImagesUpdate PUT /api/v1.1/verifications/{verification_id}/images/{image_id}/
    MobidKycApi.ApiApi apiV11VerificationsList GET /api/v1.1/verifications/
    MobidKycApi.ApiApi apiV11VerificationsPartialUpdate PATCH /api/v1.1/verifications/{verification_id}/
    MobidKycApi.ApiApi apiV11VerificationsRead GET /api/v1.1/verifications/{verification_id}/
    MobidKycApi.ApiApi apiV11VerificationsUpdate PUT /api/v1.1/verifications/{verification_id}/
    MobidKycApi.ApiTokenAuthApi apiTokenAuthCreate POST /api-token-auth/ API View that receives a POST with a user's username and password.
    MobidKycApi.ApiTokenRefreshApi apiTokenRefreshCreate POST /api-token-refresh/ API View that returns a refreshed token (with new expiration) based on existing token
    MobidKycApi.ApiTokenVerifyApi apiTokenVerifyCreate POST /api-token-verify/

    Documentation for Models

    Documentation for Authorization

    Bearer

    • Type: API key
    • API key parameter name: Authorization
    • Location: HTTP header

    Keywords

    none

    Install

    npm i kyc-js-sdk

    DownloadsWeekly Downloads

    1

    Version

    1.1.0

    License

    Unlicense

    Unpacked Size

    170 kB

    Total Files

    46

    Last publish

    Collaborators

    • glg2