Skip to contentSkip to navigationSkip to topbar
Twilio Docs
Rate this page:
On this page

Silent Network Auth Create an EVURL API Endpoint

(information)

Info

Before Starting

There are a number of keys and base level platform items to consider such as request construction. Please read our Platform and Integration guide before you start integration.

POST https://api-sbox.dnlsrv.com/cigateway/id/v1/phoneIdUrl

An API that allows a customer to fetch a unique URL to be used to start the Silent Network Auth process. Note that the URL provided by Twilio is valid only for ten minutes.

Body params

body-params page anchor
Param NameTypeDescription
merchantIdstringRequired. Your merchant ID that will be provided to you during onboarding.
subMerchantIdstringOptional. Used by resellers, an ID that is assigned to the end customer.
consentIdstringRequired. Unique ID for the consent that is traceable if consent audit is required.
consentTimeStampdate-timeRequired. The time stamp that the consentId was generated. Format must be as date time RFC3339.
consumerMdnstringRequired. The MSISDN of the user that you want to check. Number to be provided in E.164 format.
correlationIdstringRequired. A nonce used by the customer that is unique to this transaction.
consumerDeviceIPstringOptional. The IP address of the user at the time of customer interaction, if known. IP address is used to identify if the user is on a supported carrier network.
consumerDeviceUAstringOptional. The User Agent string of the device which will help Twilio understand the type of device that is being used.
airbooleanOptional. Allow HTTPS to HTTP redirect, if detection is supported only via http by the user's mobile carrier.
redirectUrlstringOptional. The redirectUrl allows the customer to regain control of the consumer flow after the phone number verification process is completed.If redirect parameter is not provided, Twilio will send HTTP 200 response.
useCasestringOptional. Numeric identifier attribute which contains use case information for the Silent Network Auth transaction. Can be one of:"1": Login use case"2": Registration use case"3": Transactional use case

Headers

headers page anchor
Header NameTypeDescription
AuthorizationstringRequired. The security key to use for Twilio APIs.NOTE: This may be different than your Twilio Account Auth Token - please confirm with your Sales Specialist.
Content-TypestringRequired. Media type sent in the request. Only application/json is supported.
AcceptstringRequired. Media type for the response. Only application/json is supported.
RequestTimedate-timeRequired. Current date time when request is sent.

Responses

responses page anchor

Successful response

successful-response page anchor

A results JSON object will be returned with the following values if the request was successful.

Value NameTypeDescription
correlationIdstringA nonce used by the customer that is unique to this transaction. This value is echoed back from the request, if it was provided.
referenceIdstringTwilio's unique transaction identifier.
EVURLstringURL to which the end user's device should be redirected to complete Silent Network Auth.

Sample successful response


_10
HTTP/1.1 200 OK
_10
Content-Type: application/json
_10
_10
{
_10
"results": {
_10
"correlationId": "ABC0881973286793",
_10
"referenceId": "20210204234640M163C264030",
_10
"EVURL": "https://mi-sbox.dnlsrv.com/msbox/id/t20AHVnl?data=rmGtT04jwmgYhzW9OPw9P%2F1h1nZPqMZXbo%2B03SWQFJtXOq5SYHGhK1Bg4%2F666V55Zdq0dKkDVPNZjfS3duY1i1WCvaFEAIh6Cau4nuW29akzZxAfpWZCyDMFnrLihmpO54olamo6AOJCTzg4fIdGQEO9J291b8QhziMbd1RDWm5i9aCTg5O6v156vS%2BQQz0HwBfjJPPZ0eY5OR3sTUI58sK%2BgFEdV6pRPjN7VZz%2BKAJ3hwFWljJoHurWYHyqoIwnSuDh2EToE1JSRdSjaqEY2wedSJyYHMPjSTtXDm0H45ERO8tw7sdke8gkAE1Clcbj5mlCBBA%3D&cipherSalt=6tKfsd76F7j3hvbK&redirect=https%3A%2F%2FMerchantSite%2FRedirect&air=false"
_10
}
_10
}

Failed response

failed-response page anchor

An error JSON object will be returned with the following values if the request failed.

Value NameTypeDescription
codestringIndicates the reason the API call failed. Refer to Error Codes and Descriptions for a complete list.
descriptionstringAdditional information regarding the error condition. Sent only if error code is included in the response.
correlationIdstringA nonce used by the customer that is unique to this transaction. This value is echoed back from the request, if it was provided.
referenceIdstringTwilio's unique transaction identifier, if available.

Sample failed response


_11
HTTP/1.1 400 Bad Request
_11
Content-Type: application/json
_11
_11
{
_11
"error": {
_11
"correlationId": "ABC0881973286793",
_11
"referenceId": "20210204234640M163C264030",
_11
"code": "-5003",
_11
"description": "Required parameter missing"
_11
}
_11
}

HTTP status codes

http-status-codes page anchor
HTTP Status CodeDescription
200Successful operation.
400Malformed request submitted.
500Internal system error.

Create an EVURL Example

create-an-evurl-example page anchor
Node.js
Python
C#
Java
PHP
Ruby
curl

_24
// Installation
_24
// npm install api --save
_24
_24
// Request
_24
const sdk = require('api')('@boku/v4.4.1#1b5wc11kl6dx748s');
_24
_24
sdk.postV1Phoneidurl({
_24
merchantId: '02200013919FB4',
_24
subMerchantId: '00DF00000016',
_24
consentId: '9783471AFDB69NH34',
_24
consentTimeStamp: '2020-08-20T12:00:57+00:00',
_24
consumerMdn: '+14085040458',
_24
correlationId: '244464DFCB537E56',
_24
consumerDeviceIP: '213.27.12.111',
_24
consumerDeviceUA: 'Mozilla/5.0 (Linux; Android 6.0; Nexus 5 Build/MRA58N) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/81.0.4044.138 Mobile Safari/537.36',
_24
air: false,
_24
redirectUrl: 'https://MerchantSite/Redirect',
_24
useCase: '1'
_24
}, {
_24
authorization: 'sha512-OrXJ9cUS2ZeapEbLBiONVK/eQtBwF1Mi7z2Zg9jNB9g71zvGSBXHqqhwfrfTD9WiNT+FIKOPvjToU/nhjml6Mw==?E5No',
_24
requesttime: '2022-08-01T09:33:43+00:00'
_24
})
_24
.then(({ data }) => console.log(data))
_24
.catch(err => console.error(err));

Output

_10
{
_10
"results": {
_10
"evurl": "https://mi-sbox.dnlsrv.com/msbox/id/t20AHVnl?data=rmGtT04jwmgYhzW9OPw9P%2F1h1nZPqMZXbo%2B03SWQFJtXOq5SYHGhK1Bg4%2F666V55Zdq0dKkDVPNZjfS3duY1i1WCvaFEAIh6Cau4nuW29akzZxAfpWZCyDMFnrLihmpO54olamo6AOJCTzg4fIdGQEO9J291b8QhziMbd1RDWm5i9aCTg5O6v156vS%2BQQz0HwBfjJPPZ0eY5OR3sTUI58sK%2BgFEdV6pRPjN7VZz%2BKAJ3hwFWljJoHurWYHyqoIwnSuDh2EToE1JSRdSjaqEY2wedSJyYHMPjSTtXDm0H45ERO8tw7sdke8gkAE1Clcbj5mlCBBA%3D&cipherSalt=6tKfsd76F7j3hvbK&redirect=https%3A%2F%2FMerchantSite%2FRedirect&air=false",
_10
"correlationId": "244464DFCB537E56",
_10
"referenceId": "20221202163744M16301C147600"
_10
}
_10
}

Rate this page: