Skip to content

Latest commit

 

History

History
284 lines (206 loc) · 9.46 KB

VerifyApi.md

File metadata and controls

284 lines (206 loc) · 9.46 KB
Raw

Swagger\Client\VerifyApi

All URIs are relative to https://slingshot.egoiapp.com/api/

Method HTTP request Description
cancelVerify POST /v2/verify/{id}/cancel Cancel Verify Request
getVerify GET /v2/verify/{id} Get Verify Request
requestVerify POST /v2/verify/request Request Verify
resendVerify POST /v2/verify/{id}/resend Resend Verify Code
validateVerifyCode POST /v2/verify/{id}/validate Validate Verify Code

cancelVerify

\Swagger\Client\Model\VerifyIdResponse[] cancelVerify($id)

Cancel Verify Request

This method will cancel the requested verify. No codes will be further generated or confirmed within the context of the id of the message

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: ApiKey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('ApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('ApiKey', 'Bearer');

$apiInstance = new Swagger\Client\Api\VerifyApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = "id_example"; // string | The id of the Verify Request

try {
    $result = $apiInstance->cancelVerify($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VerifyApi->cancelVerify: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id string The id of the Verify Request

Return type

\Swagger\Client\Model\VerifyIdResponse[]

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getVerify

\Swagger\Client\Model\CheckVerifyResponse getVerify($id)

Get Verify Request

This method gets a verify requests, including status of it

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: ApiKey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('ApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('ApiKey', 'Bearer');

$apiInstance = new Swagger\Client\Api\VerifyApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = "id_example"; // string | The id of the Verify Request

try {
    $result = $apiInstance->getVerify($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VerifyApi->getVerify: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id string The id of the Verify Request

Return type

\Swagger\Client\Model\CheckVerifyResponse

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

requestVerify

\Swagger\Client\Model\VerifyIdResponse requestVerify($body)

Request Verify

This method will generate a code and send a message with it to a recipient

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: ApiKey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('ApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('ApiKey', 'Bearer');

$apiInstance = new Swagger\Client\Api\VerifyApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$body = new \Swagger\Client\Model\VerifyRequest(); // \Swagger\Client\Model\VerifyRequest | 

try {
    $result = $apiInstance->requestVerify($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VerifyApi->requestVerify: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
body \Swagger\Client\Model\VerifyRequest [optional]

Return type

\Swagger\Client\Model\VerifyIdResponse

Authorization

ApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

resendVerify

\Swagger\Client\Model\VerifyIdResponse[] resendVerify($id)

Resend Verify Code

This method will resend the requested verify. A new code will be generated and sent to the recipient

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: ApiKey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('ApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('ApiKey', 'Bearer');

$apiInstance = new Swagger\Client\Api\VerifyApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = "id_example"; // string | The id of the Verify Request

try {
    $result = $apiInstance->resendVerify($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VerifyApi->resendVerify: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id string The id of the Verify Request

Return type

\Swagger\Client\Model\VerifyIdResponse[]

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

validateVerifyCode

\Swagger\Client\Model\VerifyIdResponse[] validateVerifyCode($id, $body)

Validate Verify Code

This method validates the code submitted by the recipient. This request should be made by the sender of the Verify request

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: ApiKey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('ApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('ApiKey', 'Bearer');

$apiInstance = new Swagger\Client\Api\VerifyApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = "id_example"; // string | The id of the Verify Request
$body = new \Swagger\Client\Model\ValidateCodeVerifyRequest(); // \Swagger\Client\Model\ValidateCodeVerifyRequest | 

try {
    $result = $apiInstance->validateVerifyCode($id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VerifyApi->validateVerifyCode: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id string The id of the Verify Request
body \Swagger\Client\Model\ValidateCodeVerifyRequest [optional]

Return type

\Swagger\Client\Model\VerifyIdResponse[]

Authorization

ApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]