php-helper-files

sample APIs for tests.php

How to use the SDK

Request OTP code

require_once("./BIDOTP.php");

$tenantInfo = array("dns" => "$dns", "communityName" => "$communityName", "licenseKey" => "$licenseKey");

$otpResponse = BIDOTP::requestOTP($tenantInfo, "$userId", "$emailorNull", "$phoneOrNull", "$countryCode");

Verify OTP code

require_once("./BIDOTP.php");

$tenantInfo = array("dns" => "$dns", "communityName" => "$communityName", "licenseKey" => "$licenseKey");

$verifyOTPResponse = BIDOTP::verifyOTP($tenantInfo, "$userId", "$code");

Create UWL2.0 session

require_once("./BIDSession.php");

$tenantInfo = array("dns" => "$dns", "communityName" => "$communityName", "licenseKey" => "$licenseKey");

$createdSessionResponse = BIDSession::createNewSession($tenantInfo, null, null);

Poll for UWL2.0 session

require_once("./BIDSession.php");

$tenantInfo = array("dns" => "$dns", "communityName" => "$communityName", "licenseKey" => "$licenseKey");

$pollSessionResponse = BIDSession::pollSession($tenantInfo, "$sessionId", TRUE, TRUE);

FIDO device registration options

require_once("./BIDWebAuthn.php");

$tenantInfo = array("dns" => "$dns", "communityName" => "$communityName", "licenseKey" => "$licenseKey");

//authenticatorSelection

// if your device is a security key, such as a YubiKey:
"attestation" => "direct",
    "authenticatorSelection" => array(
        "requireResidentKey" => true
    )

// if your device is a platform authenticator, such as TouchID
"attestation" => "direct",
    "authenticatorSelection" => array(
        "authenticatorAttachment" => "platform"
    )

// if your device is a MacBook
"attestation" => "none"

// sample options request object for YubiKey
$optionsRequest = array(
    "displayName" => "<displayname>",
    "username" => "<username>",
    "dns" => "<current domain>",
    "attestation" => "<attestation>",
    "authenticatorSelection" => array(
        "requireResidentKey" => true
    )
);
$attestationOptionsResponse = BIDWebAuthn::fetchAttestationOptions($tenantInfo, $optionsRequest);

FIDO device registration result

require_once("./BIDWebAuthn.php");

$tenantInfo = array("dns" => "$dns", "communityName" => "$communityName", "licenseKey" => "$licenseKey");

$resultRequest = array(
    "rawId" => "<rawId>",
    "response" => array(
        "attestationObject" => "<attestationObject>",
        "getAuthenticatorData" => "<getAuthenticatorData>",
        "getPublicKey" => "<getPublicKey>",
        "getPublicKeyAlgorithm" => "<getPublicKeyAlgorithm>",
        "getTransports" => "<getTransports>",
        "clientDataJSON" => "<clientDataJSON>"
    ),
    "authenticatorAttachment" => "<authenticatorAttachment>",
    "getClientExtensionResults" => "<getClientExtensionResults>",
    "id" => "<id>",
    "type" => "<type>",
    "dns" => "<current domain>"
);

$attestationResultResponse = BIDWebAuthn::submitAttestationResult($tenantInfo, $resultRequest);

FIDO device authentication options

require_once("./BIDWebAuthn.php");

$tenantInfo = array("dns" => "$dns", "communityName" => "$communityName", "licenseKey" => "$licenseKey");

$optionsRequest = array(
    "username" => "<username>",
    "displayName" => "<displayName>",
    "dns" => "<current domain>"
);

$assertionOptionsResponse = BIDWebAuthn::fetchAssertionOptions($tenantInfo, $optionsRequest);

FIDO device authentication result

require_once("./BIDWebAuthn.php");

$tenantInfo = array("dns" => "$dns", "communityName" => "$communityName", "licenseKey" => "$licenseKey");

$resultRequest = array(
    "rawId" => "<rawId>",
    "response" => array(
        "authenticatorData" => "<authenticatorData>",
        "signature" => "<signature>",
        "userHandle" => "<userHandle>",
        "clientDataJSON" => "<clientDataJSON>"
    ),
    "getClientExtensionResults" => "<getClientExtensionResults>",
    "id" => "<id>",
    "type" => "<type>",
    "dns" => "<current domain>"
);

$assertionResultResponse = BIDWebAuthn::submitAssertionResult($tenantInfo, $resultRequest);

Request Email verification link

require_once("./BIDAccessCodes.php");

$tenantInfo = array("dns" => "$dns", "communityName" => "$communityName", "licenseKey" => "$licenseKey");

$requestEmailVerificationResponse = BIDAccessCode::requestEmailVerificationLink($tenantInfo, "$emailTo", "$emailTemplateB64OrNull", "$emailSubjectOrNull", "$createdBy", "$ttl_seconds_or_null");

Verify and Redeem Email verification link

require_once("./BIDAccessCodes.php");

$tenantInfo = array("dns" => "$dns", "communityName" => "$communityName", "licenseKey" => "$licenseKey");

$redeemVerificationCodeResponse = BIDAccessCode::verifyAndRedeemEmailVerificationCode($tenantInfo, "$code");

Create new Driver's License verification session

require_once("./BIDVerifyDocument.php");

$tenantInfo = array("dns" => "$dns", "communityName" => "$communityName", "licenseKey" => "$licenseKey");

$createdSessionResponse = BIDVerifyDocument::createDocumentSession($tenantInfo, "$dvcId", "$documentType");

Trigger SMS

require_once("./BIDMessaging.php");

$tenantInfo = array("dns" => "$dns", "communityName" => "$communityName", "licenseKey" => "$licenseKey");

$smsResponse = BIDMessaging::sendSMS($tenantInfo, "$smsTo", "$smsISDCode", "$smsTemplateB64");

Poll for Driver's License session response

require_once("./BIDVerifyDocument.php");

$tenantInfo = array("dns" => "$dns", "communityName" => "$communityName", "licenseKey" => "$licenseKey");

$pollSessionResponse = BIDVerifyDocument::pollSessionResult($tenantInfo, "$dvcId", "$sessionId");

Request verifiable credentials for ID

require_once("./BIDVerifiableCredential.php");

$tenantInfo = array("dns" => "$dns", "communityName" => "$communityName", "licenseKey" => "$licenseKey");

// sample vcs object (see {tenant-dns}/vcs/docs for up to date request structure)
// example: https://blockid-trial.1kosmos.net/vcs/docs/#/Credentials/post_tenant__tenantId__community__communityId__vc_from_document__type_

$issuedVerifiableCredential = BIDVerifiableCredential::requestVCForID($tenantInfo, "$type", "$document", "$userDid", "$userPublickey", "$userUrn");

Verify verifiable credentials

require_once("./BIDVerifiableCredential.php");

$tenantInfo = array("dns" => "$dns", "communityName" => "$communityName", "licenseKey" => "$licenseKey");

// sample vcs object (see {tenant-dns}/vcs/docs for up to date request structure)
// example: https://blockid-trial.1kosmos.net/vcs/docs/#/Credentials/post_tenant__tenantId__community__communityId__vc_verify

$verifiedVCResponse = BIDVerifiableCredential::verifyCredential($tenantInfo, "$vc");

Request verifiable presentation

require_once("./BIDVerifiableCredential.php");

$tenantInfo = array("dns" => "$dns", "communityName" => "$communityName", "licenseKey" => "$licenseKey");

// sample vcs object (see {tenant-dns}/vcs/docs for up to date request structure)
// example: https://blockid-trial.1kosmos.net/vcs/docs/#/Credentials/post_tenant__tenantId__community__communityId__vp_create

$vpResponse = BIDVerifiableCredential::requestVPForCredentials($tenantInfo, "$vcs", "$createShareUrl");

Verify verifiable presentation

require_once("./BIDVerifiableCredential.php");

$tenantInfo = array("dns" => "$dns", "communityName" => "$communityName", "licenseKey" => "$licenseKey");

// sample vcs object (see {tenant-dns}/vcs/docs for up to date request structure)
// example: https://blockid-trial.1kosmos.net/vcs/docs/#/Credentials/post_tenant__tenantId__community__communityId__vp_verify

$verifiedVP = BIDVerifiableCredential::verifyPresentation($tenantInfo, "$vp")

Request verifiable credentials for Payload

require_once("./BIDVerifiableCredential.php");

$tenantInfo = array("dns" => "$dns", "communityName" => "$communityName", "licenseKey" => "$licenseKey");

// sample vcs object (see {tenant-dns}/vcs/docs for up to date request structure)
// example: https://blockid-trial.1kosmos.net/vcs/docs/#/Credentials/post_tenant__tenantId__community__communityId__vc_from_payload__type_

$payloadVCResponse = BIDVerifiableCredential::requestVCForPayload($tenantInfo, "$type", "$issuer", "$info", "$userDid", "$userPublickey", "$userUrn");

Get verifiable credentials status

require_once("./BIDVerifiableCredential.php");

$tenantInfo = array("dns" => "$dns", "communityName" => "$communityName", "licenseKey" => "$licenseKey");

// sample vcs object (see {tenant-dns}/vcs/docs for up to date request structure)
// example: https://blockid-trial.1kosmos.net/vcs/docs/#/Credentials/get_tenant__tenantId__community__communityId__vc__vcId__status

$vcStatus = BIDVerifiableCredential::getVcStatusById($tenantInfo, "$vcId");

Get VP with download URI

require_once("./BIDVerifiableCredential.php");

$vpResponse =  BIDVerifiableCredential::getVPWithDownloadUri("$licenseKey", "$keySet", "$downloadUri", "$requestID");

Verify VP with download URI

require_once("./BIDVerifiableCredential.php");

$verifiedVP =  BIDVerifiableCredential::verifyVPWithDownloadUri("$licenseKey", "$keySet", "$downloadUri", "$vp", "$requestID");

Request OAuth2 authorization code

require_once("./BIDOauth2.php");

$tenantInfo = array("dns" => "$dns", "communityName" => "$communityName", "licenseKey" => "$licenseKey");

$authorizationCodeResponse = BIDOauth2::requestAuthorizationCode($tenantInfo, "$proofOfAuthenticationJwt", "$clientId", "$responseType", "$scope", "$redirectUri", "$stateOrNull", "$nonceOrNull");

Request OAuth2 Tokens

require_once("./BIDOauth2.php");

$tenantInfo = array("dns" => "$dns", "communityName" => "$communityName", "licenseKey" => "$licenseKey");

$requestTokenResponse = BIDOauth2::requestToken($tenantInfo, "$clientId", "$clientSecret", "$grantType", "$redirectUri", "$codeOrNull", "$refreshTokenOrNull");