public interface ConsumerApi
| Modifier and Type | Method and Description |
|---|---|
retrofit2.Call<AuthResult> |
authenticate(String appId,
String installId,
String jwt,
Map<String,okhttp3.RequestBody> partMap)
Same endpoint as
authenticate(String, String, String, String, String, String, String, String, String[], String[], String, String, String, String, String, String, String, String, RequestBody)
but the Parts are provided through a PartMap. |
retrofit2.Call<AuthResult> |
authenticate(String appId,
String installId,
String jwt,
String code,
String customKey,
String blurScore,
String timestamp,
String appVersion,
String[] qrCenters,
String[] cropOffset,
String latitude,
String longitude,
String positioning,
String deviceModel,
String deviceKernel,
String deviceImei,
String deviceOs,
String deviceOsVersion,
okhttp3.RequestBody fingerprint_image)
Authentication endpoint.
|
retrofit2.Call<VersionCompatibilityResult> |
checkApiVersionCompatibility(String mobileApiVersion)
Verifies the compatibility of the app's api
|
retrofit2.Call<PreCheckResult> |
getPreCheck(String appId,
String installId,
String code,
String deviceModel)
Fetches the
PreCheckResult info of a given code. |
retrofit2.Call<AuthResult> |
sendInsufficientQualityCode(String appId,
String installId,
String jwt,
Map<String,okhttp3.RequestBody> partMap)
Same endpoint as
sendInsufficientQualityCode(String, String, String, String, String, String, String, String, String, String[], String[], String, String, String, String, String, String, String, String, RequestBody)
but the Parts are provided through a PartMap. |
retrofit2.Call<AuthResult> |
sendInsufficientQualityCode(String appId,
String installId,
String jwt,
String code,
String customKey,
String isUnreadable,
String blurScore,
String timestamp,
String appVersion,
String[] qrCenters,
String[] cropOffset,
String latitude,
String longitude,
String positioning,
String deviceModel,
String deviceKernel,
String deviceImei,
String deviceOs,
String deviceOsVersion,
okhttp3.RequestBody fingerprint_image)
Authentication endpoint for codes with quality issues.
|
retrofit2.Call<AuthResult> |
sendUnsupportedRequest(String appId,
String installId,
String jwt,
Map<String,okhttp3.RequestBody> partMap)
Same endpoint as
sendUnsupportedRequest(String, String, String, String, String, String, String, String, String, String, String, String, String, String)
but the Parts are provided through a PartMap. |
retrofit2.Call<AuthResult> |
sendUnsupportedRequest(String appId,
String installId,
String jwt,
String code,
String timestamp,
String appVersion,
String latitude,
String longitude,
String positioning,
String deviceModel,
String deviceKernel,
String deviceImei,
String deviceOs,
String deviceOsVersion)
Query endpoint used for phones that do not support the authentication
|
retrofit2.Call<QrImageResult> |
syncQr(String appId,
String installId,
String uuid,
okhttp3.RequestBody qrImage)
Update endpoint used to send the full image after having called the
authenticate(String, String, String, Map) with the crop of the secure graphic. |
@Multipart @POST(value="api/scan/verify/") retrofit2.Call<AuthResult> authenticate(@Header(value="x-scantrust-app") String appId, @Header(value="x-scantrust-install-id") String installId, @Header(value="Authorization") String jwt, @Part(value="extended_id") String code, @Part(value="custom_key") String customKey, @Part(value="blur_score") String blurScore, @Part(value="mobile_scan_timestamp") String timestamp, @Part(value="mobile_app_version") String appVersion, @Part(value="qr_patterns_centers") String[] qrCenters, @Part(value="crop_offset") String[] cropOffset, @Part(value="location.latitude") String latitude, @Part(value="location.longitude") String longitude, @Part(value="location.positioning") String positioning, @Part(value="device.model") String deviceModel, @Part(value="device.kernel") String deviceKernel, @Part(value="device.imei") String deviceImei, @Part(value="device.os") String deviceOs, @Part(value="device.os_version") String deviceOsVersion, @Part(value="image\"; filename=\"image.jpg") okhttp3.RequestBody fingerprint_image)
The image that is provided will be run through the authentication algorithms.
appId - The application identification nameinstallId - The current app install idjwt - Optional: JWT provided by the server preceded by "JWT ", for example "JWT eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJFeGFtcGxlIiwibmFtZSI6IkpvaG4gRG9lIiwiZXhwIjoxNDgyNjI0MDAxfQ.2RVoDg2MFJofsOqkauupdgEBgGyF7iZLIe4cRtYCjds".code - The code idcustomKey - Optional: the code's custom keyblurScore - The code's blur scoretimestamp - The scan timestampappVersion - The app's version numberqrCenters - The code's pattern centerscropOffset - The crop offset to the provided image.latitude - The latitude when scannedlongitude - The longitude when scannedpositioning - The positioning system that was used for the lat & longdeviceModel - The device's modeldeviceKernel - The device's kerneldeviceImei - Optional: The device's IMEIdeviceOs - The device's OSdeviceOsVersion - The device's OS versionfingerprint_image - The fingerprint imageAuthResult@Multipart @POST(value="api/scan/verify/") retrofit2.Call<AuthResult> authenticate(@Header(value="x-scantrust-app") String appId, @Header(value="x-scantrust-install-id") String installId, @Header(value="Authorization") String jwt, @PartMap Map<String,okhttp3.RequestBody> partMap)
authenticate(String, String, String, String, String, String, String, String, String[], String[], String, String, String, String, String, String, String, String, RequestBody)
but the Parts are provided through a PartMap. The part map can be obtained easily using the sdk helper method.appId - The application identification nameinstallId - The current app install idjwt - Optional: JWT provided by the server preceded by "JWT ", for example "JWT eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJFeGFtcGxlIiwibmFtZSI6IkpvaG4gRG9lIiwiZXhwIjoxNDgyNjI0MDAxfQ.2RVoDg2MFJofsOqkauupdgEBgGyF7iZLIe4cRtYCjds".partMap - The PartMap containing the different request PartsAuthResult@Multipart @POST(value="api/scan/verify/") retrofit2.Call<AuthResult> sendInsufficientQualityCode(@Header(value="x-scantrust-app") String appId, @Header(value="x-scantrust-install-id") String installId, @Header(value="Authorization") String jwt, @Part(value="extended_id") String code, @Part(value="custom_key") String customKey, @Part(value="unreadable") String isUnreadable, @Part(value="blur_score") String blurScore, @Part(value="mobile_scan_timestamp") String timestamp, @Part(value="mobile_app_version") String appVersion, @Part(value="qr_patterns_centers") String[] qrCenters, @Part(value="crop_offset") String[] cropOffset, @Part(value="location.latitude") String latitude, @Part(value="location.longitude") String longitude, @Part(value="location.positioning") String positioning, @Part(value="device.model") String deviceModel, @Part(value="device.kernel") String deviceKernel, @Part(value="device.imei") String deviceImei, @Part(value="device.os") String deviceOs, @Part(value="device.os_version") String deviceOsVersion, @Part(value="image\"; filename=\"image.jpg") okhttp3.RequestBody fingerprint_image)
The image that is provided will be run through the authentication algorithms.
appId - The application identification nameinstallId - The current app install idjwt - Optional: JWT provided by the server preceded by "JWT ", for example "JWT eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJFeGFtcGxlIiwibmFtZSI6IkpvaG4gRG9lIiwiZXhwIjoxNDgyNjI0MDAxfQ.2RVoDg2MFJofsOqkauupdgEBgGyF7iZLIe4cRtYCjds".code - The code idcustomKey - Optional: the code's custom keyisUnreadable - Indicates that the quality of the code (print and/or capture) was insufficientblurScore - The code's blur scoretimestamp - The scan timestampappVersion - The app's version numberqrCenters - The code's pattern centerscropOffset - The crop offset to the provided image.latitude - The latitude when scannedlongitude - The longitude when scannedpositioning - The positioning system that was used for the lat & longdeviceModel - The device's modeldeviceKernel - The device's kerneldeviceImei - Optional: The device's IMEIdeviceOs - The device's OSdeviceOsVersion - The device's OS versionfingerprint_image - The fingerprint imageAuthResult@Multipart @POST(value="api/scan/verify/") retrofit2.Call<AuthResult> sendInsufficientQualityCode(@Header(value="x-scantrust-app") String appId, @Header(value="x-scantrust-install-id") String installId, @Header(value="Authorization") String jwt, @PartMap Map<String,okhttp3.RequestBody> partMap)
sendInsufficientQualityCode(String, String, String, String, String, String, String, String, String, String[], String[], String, String, String, String, String, String, String, String, RequestBody)
but the Parts are provided through a PartMap. The part map can be obtained easily using the sdk helper method.appId - The application identification nameinstallId - The current app install idjwt - Optional: JWT provided by the server preceded by "JWT ", for example "JWT eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJFeGFtcGxlIiwibmFtZSI6IkpvaG4gRG9lIiwiZXhwIjoxNDgyNjI0MDAxfQ.2RVoDg2MFJofsOqkauupdgEBgGyF7iZLIe4cRtYCjds".partMap - The PartMap containing the different request PartsAuthResult@Multipart @POST(value="api/scan/unsupported-phone/") retrofit2.Call<AuthResult> sendUnsupportedRequest(@Header(value="x-scantrust-app") String appId, @Header(value="x-scantrust-install-id") String installId, @Header(value="Authorization") String jwt, @Part(value="extended_id") String code, @Part(value="mobile_scan_timestamp") String timestamp, @Part(value="mobile_app_version") String appVersion, @Part(value="location.latitude") String latitude, @Part(value="location.longitude") String longitude, @Part(value="location.positioning") String positioning, @Part(value="device.model") String deviceModel, @Part(value="device.kernel") String deviceKernel, @Part(value="device.imei") String deviceImei, @Part(value="device.os") String deviceOs, @Part(value="device.os_version") String deviceOsVersion)
appId - The application identification nameinstallId - The current app install idjwt - Optional: JWT provided by the server preceded by "JWT ", for example "JWT eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJFeGFtcGxlIiwibmFtZSI6IkpvaG4gRG9lIiwiZXhwIjoxNDgyNjI0MDAxfQ.2RVoDg2MFJofsOqkauupdgEBgGyF7iZLIe4cRtYCjds".code - The code idtimestamp - The scan timestampappVersion - The app's version numberlatitude - The latitude when scannedlongitude - The longitude when scannedpositioning - The positioning system that was used for the lat & longdeviceModel - The device's modeldeviceKernel - The device's kerneldeviceImei - Optional: The device's IMEIdeviceOs - The device's OSdeviceOsVersion - The device's OS versionAuthResult@Multipart @POST(value="api/scan/unsupported-phone/") retrofit2.Call<AuthResult> sendUnsupportedRequest(@Header(value="x-scantrust-app") String appId, @Header(value="x-scantrust-install-id") String installId, @Header(value="Authorization") String jwt, @PartMap Map<String,okhttp3.RequestBody> partMap)
sendUnsupportedRequest(String, String, String, String, String, String, String, String, String, String, String, String, String, String)
but the Parts are provided through a PartMap. The part map can be obtained easily using the sdk helper method.appId - The application identification nameinstallId - The current app install idjwt - Optional: JWT provided by the server preceded by "JWT ", for example "JWT eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJFeGFtcGxlIiwibmFtZSI6IkpvaG4gRG9lIiwiZXhwIjoxNDgyNjI0MDAxfQ.2RVoDg2MFJofsOqkauupdgEBgGyF7iZLIe4cRtYCjds".partMap - The PartMap containing the different request PartsAuthResult@Multipart @PATCH(value="api/scan/sync/qr-image/") retrofit2.Call<QrImageResult> syncQr(@Header(value="x-scantrust-app") String appId, @Header(value="x-scantrust-install-id") String installId, @Part(value="uuid") String uuid, @Part(value="image\"; filename=\"image.jpg") okhttp3.RequestBody qrImage)
authenticate(String, String, String, Map) with the crop of the secure graphic.appId - The application identification nameinstallId - The current app install iduuid - The UUID of the scan entry obtained via a call to the authentication endpointqrImage - The image of the whole codeQrImageResult@GET(value="/api/v2/mobile/version-compatibility/") retrofit2.Call<VersionCompatibilityResult> checkApiVersionCompatibility(@Query(value="version") String mobileApiVersion)
mobileApiVersion - The app's version numberVersionCompatibilityResult@POST(value="/api/scan/pre-check/") @FormUrlEncoded retrofit2.Call<PreCheckResult> getPreCheck(@Header(value="x-scantrust-app") String appId, @Header(value="x-scantrust-install-id") String installId, @Field(value="message") String code, @Field(value="device") String deviceModel)
PreCheckResult info of a given code.appId - The application identification nameinstallId - The current app install idcode - The code iddeviceModel - The phone modelPreCheckResult