Create Shield assessment

Runs a device-risk assessment for the given Shield session and returns the standardized
Smile Shield result.

This endpoint is billed per query. To read the same result
again without being billed, use GET /shield/sessions/{sessionId}/assessments/{assessmentId}.

Supplying more attributes produces a richer result: several output fields (for
example the digital identity pair scores and phoneIntelligence) are only populated when
the corresponding input is present.

Sandbox test values

In Sandbox, any request that passes validation returns the same mock result. The values
used in the examples are only there to keep the sample self-explanatory:

FieldTest value
emailAddress[email protected]
firstName / lastNameGeorge / Palomero
phoneNumber63955991234
addressCountryPH

resultCode is SUCCESS for every valid Sandbox request. NO_DATA means the Smile
returned no usable data for the session; SYSTEM_ERROR / SERVICE_UNAVAILABLE are
infrastructure failures that can be retried.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Shield session ID returned by the Shield SDK when the session starts.

Body Params

Every attribute is optional on its own, but the more you supply the richer the result. Fields such as the digital identity pair scores and phoneIntelligence are only populated when the corresponding input is present.

string
length ≤ 64

Your local identifier for this transaction, for example the loan application ID.

string
length ≤ 128

The first name associated with this event. Used together with lastName as an alternative to emailAddress and ipAddress.

string
length ≤ 128

The last name associated with this event. Used together with firstName as an alternative to emailAddress and ipAddress.

string
length ≤ 255

The email address associated with this event.

string
length ≤ 45

The applicant's IP address, IPv4 or IPv6.

string
length ≤ 32

The applicant's mobile number. Must start with the country code, for example 63955991234, and must not contain a leading 0 or a +.

address
object

Applicant's billing address. All fields are optional.

Responses

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json