Cdn API - CPG Source

<back to all web services

SmsVerificationChallengeRequest

Cdn.Api

The following routes are available for this service:
POST/SmsVerificationChallengeRequest
SmsVerificationChallengeRequest Parameters:
NameParameterData TypeRequiredDescription
CustomerIdbodylongNo
ChallengeTokenbodyGuidNo
CodebodystringNo
IpAddressbodystringNo
BaseRequest<T> Parameters:
NameParameterData TypeRequiredDescription
Idformlong?No
OrderByformstring[]No
OrderDirectionsformSortOrders[]No
SmsVerificationChallengeResponse Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo
MessageformstringNo
RemainingAttemptsformintNo
LastVerifiedAtformDateTime?No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
TotalformintNo
OpCodeformintNo
ErrorTextformstringNo
RequestTimeformstringNo
ResponseTimeformstringNo
TotalExecutionTimeformstringNo
CachedResponseformboolNo
SmsVerificationChallengeResponse Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo
MessageformstringNo
RemainingAttemptsformintNo
LastVerifiedAtformDateTime?No

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /SmsVerificationChallengeRequest HTTP/1.1 
Host: cdnapidev.greysheet.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CustomerId: 0,
	ChallengeToken: 00000000000000000000000000000000,
	Code: String,
	IpAddress: String,
	Id: 0,
	OrderBy: 
	[
		String
	],
	OrderDirections: 
	[
		Asc
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Success: False,
	Message: String,
	RemainingAttempts: 0,
	LastVerifiedAt: 0001-01-01,
	Total: 0,
	OpCode: 0,
	ErrorText: String,
	RequestTime: String,
	ResponseTime: String,
	TotalExecutionTime: String,
	CachedResponse: False
}