Credify.SDK 1.1.3

Credify .Net SDK

How to use

Initialization

 var signingPrivateKey = "";
 var apiKey = "";
 var env = Environment.Development;
 var config = new SdkConfig(signingPrivateKey,apiKey,env);
 var sdk = new CredifySdk(config);

Create a new account

This function generates a new user with a provided profile and password on the Credify system. The output is a new user's ID.

  var profile = new Profile
  {
      Name = new Name
      {
          FirstName = "Stephen",
          LastName = "Nguyen",
      },
      Phones = new List<Phone>
      {
          new()
          {
              PhoneNumber = "906987654",
              CountryCode = "+84"
          }
      },
      Emails = new List<Email>
      {
          new()
          {
              EmailAddress = "thisIsEmail@gmail.com"
          }
      },
  };
  var keys = new Keys
  {
      EncryptionPublicKey = "",
      EncryptionSecret = "",
      SigningPublicKey = "",
      SigningSecret = ""
  };
  var password = "Xbkqhrqqhe331@";
  var id = sdk.EntityService.CreateEntity(profile, password, keys);
  Console.WriteLine("entity created with id: " + id);

Push a custom claim

These records claim tokens into a blockchain. The claim tokens will be generated out of provided claim values.

 var claims = new Claims();
 claims.Add("this is scope-name",
     new Dictionary<string, object> {{"this is claim-name", "claim-value"}});

 var result = sdk.ClaimService.Push("provider id (oragnization id)",
     "entity id", claims);
 foreach (var commitment in result)
 {
     Console.WriteLine($"Scope name: {commitment.Key}");
     Console.WriteLine($"Commitments: {commitment.Value}");
 }

Encrypt claims

This encrypts claim values with a passed encryption public key.

 var claims = new Claims();
 claims.Add("this is scope-name",
     new Dictionary<string, object> {{"this is claim-name", "claim-value"}});
 var encrytionPublicKey = "";
 var encryptedClaims = sdk.ClaimService.Encrypt(claims, encrytionPublicKey);

Kicks off OIDC

This generates an ephemeral encryption key to secure an OIDC flow.

  var consumerId = "8f530df6-98aa-4849-bcaf-d62705435266";
  var callbackUrl = "https://callback.url";
  var initiateOidcRes = sdk.OidcService.InitiateOidc(consumerId, callbackUrl,
      new List<string> {"openid", "phone", "email", "profile"},
      new OidcOptions {ResponseType = "code"});

Introspect token

This validates the token is valid for the scope

  var token = "eyJhbGciOiJSUzI1NiIsImtpZCI6InB1YmxpYzo4ZD...WNQfpKKGKuw";
  var scope = "individual:read_evaluated_offer";
  var isActive = sdk.OidcService.IntrospectToken(token, scope);

Introspect token with result returning

This validates the token is valid for the scope

  var token = "eyJhbGciOiJSUzI1NiIsImtpZCI6InB1YmxpYzo4ZD...WNQfpKKGKuw";
  var scope = "individual:read_evaluated_offer";
  var result = sdk.OidcService.IntrospectTokenReturnResult(token, scope);

Validate request

This is for validating token

var accessToken = "...";
var requestToken =
    "...";
var approvalToken =
    "...";

var res = sdk.ClaimService.ValidateRequest(accessToken, requestToken, approvalToken);

Get offers for Market

This retrieves filtered offers list.

var res = sdk.OfferService.GetList("2988", null).Result;

Update offer transaction's status for Service Provider

The status of This update of a specified offer transaction.

var id = "xxxx";
var status = "COMPLETED";
var res = sdk.OfferService.UpdateStatus(id, status).Result;

If the transactionAmount is dynamic, you may pass transactionAmount to this function.

var id = "xxxx";
var status = "COMPLETED";
// Valid Amount's Currentcy: USD || VND || JPY
var transactionAmount = new FiatCurrency{ Currency = "USD", Value = "10"}
var res = sdk.OfferService.UpdateStatus(id, status, null, "", null).Result;

If have referenceId, you may pass referenceId to this function.

var id = "xxxx";
var status = "COMPLETED";
var referenceId = "referenceId";
var res = sdk.OfferService.UpdateStatus(id, status, null, referenceId, null).Result;

If the vat is dynamic, you may pass vat to this function.

var id = "xxxx";
var status = "COMPLETED";
// Valid Amount's Currentcy: USD || VND || JPY
var vat = new FiatCurrency{ Currency = "USD", Value = "10"}
var res = sdk.OfferService.UpdateStatus(id, status, null, "", vat).Result;

Get offer detail for Service Provider

This returns detailed information of a specified offer.

var offerCode = "offerCode";
var offer = sdk.OfferService.GetOfferDetail(offerCode).Result;

Get campaigns for Service Provider

This returns a list of campaign list.

var offerStatus = "APPROVED"; // APPROVED || REJECTED || IN_REVIEW
var campaignStatus: "APPROVED"; // APPROVED || REJECTED || IN_REVIEW || ARCHIVED || DRAFT
var result = sdk.OfferService.GetCampaigns(offerStatus, campaignStatus).Result;

Generate an access token

This manages OpenID Connect token API, generating a new access token from an authorization code. This is a helper function when you use an authorization flow.

var id = "YOUR ID";
var code = "AUTHORIZATION CODE";
var redirectUrl = "YOUR REDIRECTION URL";
var token = sdk.OidcService.GenerateAccessToken(id, code, redirectUrl).Result;

Get UserInfo

This retrieved and decrypt claim value

var userInfo = sdk.OidcService.UserInfo("accessToken", "this is your private key");