Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the cl-incognia Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed Jun 15 03:46:25 2022 GMT+0.
Next: Systems, Previous: The cl-incognia Reference Manual, Up: The cl-incognia Reference Manual [Contents][Index]
Common Lisp lightweight client library for Incognia APIs.
Incognia API Common Lisp client is available on Quicklisp.
(ql:quickload :cl-incognia)
Before calling the API methods, you need to configure your Incognia credentials:
(incognia:configure :client-id "your-client-id"
:client-secret "your-client-secret"
:region :us)
The implementation is based on the Incognia API Reference.
Authentication is done transparently so you don't need to worry about it.
This method registers a new signup for the given installation (:installation-id
), returning a risk assessment and supporting evidence (see Response Structure):
(incognia:register-signup :installation-id "your-installation-id"
:address (incognia:make-address :line "340 Avenue, CA")
This method allows you to query the latest assessment for a given signup event, identified by its :signup-id
(see Response Structure).
(incognia:get-signup-assessment :signup-id "your-signup-id")
This method registers a new login for the given installation (:installation-id
) and user account (:account-id
), returning a risk assessment and the supporting evidence (see Response Structure).
(incognia:register-login :installation-id "your-installation-id"
:account-id "your-account-id")
This method registers a new payment for the given installation (:installation-id
) and user account (:account-id
), returning a risk assessment and the supporting evidence (see Response Structure).
(incognia:register-payment :installation-id "your-installation-id"
:account-id "your-account-id"
:addresses (list
(incognia:make-address :line "340 Avenue, CA" :type :|home|)
(incognia:make-address :line "500 Street, CA" :type :|billing|)))
This method registers a feedback event for the given installation (:installation-id
) related to a signup, login or payment (see Response Structure).
(incognia:send-feedback :installation-id "your-installation-id"
:event :|verified|
:account-id "your-account-id"
:timestamp (get-universal-time))
With the exception of Sending Feedback method that returns an empty body (nil
), Incognia API response is composed by:
(:|id| "<resource-id>"
:|request-id| "<request-id>"
:|risk_assessment| "low_risk"
:|evidence| (:|account_integrity| (:|recent_high_risk_assessment| NIL)
:|last_location_ts| "2021-05-24T14:05:58.557Z"
:|distance_to_trusted_location| 50.0744
:|device_behavior_reputation| "unknown"
:|device_fraud_reputation| "allowed"
:|device_integrity| (:|from_official_store| T :|gps_spoofing| NIL :|emulator| NIL :|probable_root| NIL)
:|location_services| (:|location_sensors_enabled| NIL :|location_permission_enabled| NIL)
:|known_account| T
:|device_model| "iphone-8")
)
cl-incognia signals a condition http-request-error
when the server returned 4XX or 5XX status code.
(handler-case (incognia:register-login :installation-id "your-installation-id"
:account-id "your-account-id")
(incognia:http-request-error (e)
(format *error-output* "Incognia server returned https status code: ~D" (incognia:response-status e))))
If you have found a bug or if you have a feature request, please report them at this repository issues section.
Incognia is a location identity platform for mobile apps that enables:
Next: Modules, Previous: Introduction, Up: The cl-incognia Reference Manual [Contents][Index]
The main system appears first, followed by any subsystem dependency.
Next: Files, Previous: Systems, Up: The cl-incognia Reference Manual [Contents][Index]
Modules are listed depth-first from the system components tree.
cl-incognia (system).
Next: Packages, Previous: Modules, Up: The cl-incognia Reference Manual [Contents][Index]
Files are sorted by type and then listed depth-first from the systems components trees.
Next: cl-incognia/src/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]
cl-incognia (system).
Next: cl-incognia/src/utils.lisp, Previous: cl-incognia/cl-incognia.asd, Up: Lisp [Contents][Index]
src (module).
Next: cl-incognia/src/error.lisp, Previous: cl-incognia/src/package.lisp, Up: Lisp [Contents][Index]
package.lisp (file).
src (module).
Next: cl-incognia/src/http.lisp, Previous: cl-incognia/src/utils.lisp, Up: Lisp [Contents][Index]
utils.lisp (file).
src (module).
Next: cl-incognia/src/routes.lisp, Previous: cl-incognia/src/error.lisp, Up: Lisp [Contents][Index]
error.lisp (file).
src (module).
Next: cl-incognia/src/address.lisp, Previous: cl-incognia/src/http.lisp, Up: Lisp [Contents][Index]
http.lisp (file).
src (module).
Next: cl-incognia/src/config.lisp, Previous: cl-incognia/src/routes.lisp, Up: Lisp [Contents][Index]
routes.lisp (file).
src (module).
Next: cl-incognia/src/auth.lisp, Previous: cl-incognia/src/address.lisp, Up: Lisp [Contents][Index]
address.lisp (file).
src (module).
configure (function).
Next: cl-incognia/src/main.lisp, Previous: cl-incognia/src/config.lisp, Up: Lisp [Contents][Index]
config.lisp (file).
src (module).
Previous: cl-incognia/src/auth.lisp, Up: Lisp [Contents][Index]
auth.lisp (file).
src (module).
Next: Definitions, Previous: Files, Up: The cl-incognia Reference Manual [Contents][Index]
Packages are listed by definition order.
incognia
common-lisp.
Next: Indexes, Previous: Packages, Up: The cl-incognia Reference Manual [Contents][Index]
Definitions are sorted by export status, category, package, and then by lexicographic order.
Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]
Next: Generic functions, Previous: Public Interface, Up: Public Interface [Contents][Index]
Next: Standalone methods, Previous: Ordinary functions, Up: Public Interface [Contents][Index]
Next: Conditions, Previous: Generic functions, Up: Public Interface [Contents][Index]
Previous: Standalone methods, Up: Public Interface [Contents][Index]
error.
(quote nil)
:response-status
(quote nil)
:response-body
(quote nil)
:request-uri
(quote nil)
:request-method
Previous: Public Interface, Up: Definitions [Contents][Index]
Next: Ordinary functions, Previous: Special variables, Up: Internals [Contents][Index]
Next: Generic functions, Previous: Macros, Up: Internals [Contents][Index]
Next: Classes, Previous: Ordinary functions, Up: Internals [Contents][Index]
Next: Types, Previous: Generic functions, Up: Internals [Contents][Index]
:line
:lat
:lng
:locale
:country-code
:country-name
:state
:city
:borough
:neighborhood
common-lisp.
:number
:complements
:street
:postal-code
common-lisp.
:|home|
:type
Previous: Definitions, Up: The cl-incognia Reference Manual [Contents][Index]
Jump to: | (
A C D F G I M P R S T U |
---|
Jump to: | (
A C D F G I M P R S T U |
---|
Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]
Jump to: | *
B C L N P R S T |
---|
Jump to: | *
B C L N P R S T |
---|
Jump to: | A C E F H M P R S T U |
---|
Jump to: | A C E F H M P R S T U |
---|