Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
The cl-incognia Reference Manual
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.
Table of Contents
- 1 Introduction
- 2 Systems
- 3 Modules
- 4 Files
- 4.1 Lisp
- 4.1.1 cl-incognia/cl-incognia.asd
- 4.1.2 cl-incognia/src/package.lisp
- 4.1.3 cl-incognia/src/utils.lisp
- 4.1.4 cl-incognia/src/error.lisp
- 4.1.5 cl-incognia/src/http.lisp
- 4.1.6 cl-incognia/src/routes.lisp
- 4.1.7 cl-incognia/src/address.lisp
- 4.1.8 cl-incognia/src/config.lisp
- 4.1.9 cl-incognia/src/auth.lisp
- 4.1.10 cl-incognia/src/main.lisp
- 4.1 Lisp
- 5 Packages
- 6 Definitions
- Appendix A Indexes
Next: Systems, Previous: The cl-incognia Reference Manual, Up: The cl-incognia Reference Manual [Contents][Index]
1 Introduction
Incognia API Common Lisp Client
Common Lisp lightweight client library for Incognia APIs.
Installation
Incognia API Common Lisp client is available on Quicklisp.
(ql:quickload :cl-incognia)
Dependencies
Usage
Configuration
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)
Incognia API
The implementation is based on the Incognia API Reference.
Authentication
Authentication is done transparently so you don't need to worry about it.
Registering Signup
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")
Getting a Signup
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")
Registering Login
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")
Registering Payment
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|)))
Sending Feedback
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))
Response Structure
With the exception of Sending Feedback method that returns an empty body (nil), Incognia API response is composed by:
- id (resource id, ex., login id)
- request-id
- risk_assessment (low_risk, high_risk or unknow_risk)
- evidence
(:|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")
)
Handling Unexpected HTTP Status Code
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))))
How to Contribute
If you have found a bug or if you have a feature request, please report them at this repository issues section.
What is Incognia?
Incognia is a location identity platform for mobile apps that enables:
- Real-time address verification for onboarding
- Frictionless authentication
- Real-time transaction verification
Create a Free Incognia Account
- Go to Incognia and click on "Sign Up For Free"
- Create an Account
- You're ready to integrate Incognia SDK and use Incognia APIs
License
Next: Modules, Previous: Introduction, Up: The cl-incognia Reference Manual [Contents][Index]
2 Systems
The main system appears first, followed by any subsystem dependency.
Next: Files, Previous: Systems, Up: The cl-incognia Reference Manual [Contents][Index]
3 Modules
Modules are listed depth-first from the system components tree.
3.1 cl-incognia/src
- Source
- Parent Component
cl-incognia (system).
- Child Components
- package.lisp (file).
- utils.lisp (file).
- error.lisp (file).
- http.lisp (file).
- routes.lisp (file).
- address.lisp (file).
- config.lisp (file).
- auth.lisp (file).
- main.lisp (file).
Next: Packages, Previous: Modules, Up: The cl-incognia Reference Manual [Contents][Index]
4 Files
Files are sorted by type and then listed depth-first from the systems components trees.
4.1 Lisp
- cl-incognia/cl-incognia.asd
- cl-incognia/src/package.lisp
- cl-incognia/src/utils.lisp
- cl-incognia/src/error.lisp
- cl-incognia/src/http.lisp
- cl-incognia/src/routes.lisp
- cl-incognia/src/address.lisp
- cl-incognia/src/config.lisp
- cl-incognia/src/auth.lisp
- cl-incognia/src/main.lisp
Next: cl-incognia/src/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]
4.1.1 cl-incognia/cl-incognia.asd
- Source
- Parent Component
cl-incognia (system).
- ASDF Systems
Next: cl-incognia/src/utils.lisp, Previous: cl-incognia/cl-incognia.asd, Up: Lisp [Contents][Index]
4.1.2 cl-incognia/src/package.lisp
- Source
- Parent Component
src (module).
- Packages
Next: cl-incognia/src/error.lisp, Previous: cl-incognia/src/package.lisp, Up: Lisp [Contents][Index]
4.1.3 cl-incognia/src/utils.lisp
- Dependency
package.lisp (file).
- Source
- Parent Component
src (module).
- Internals
- parse-json (function).
- plist-remove-null-values (function).
- to-json (function).
Next: cl-incognia/src/http.lisp, Previous: cl-incognia/src/utils.lisp, Up: Lisp [Contents][Index]
4.1.4 cl-incognia/src/error.lisp
- Dependency
utils.lisp (file).
- Source
- Parent Component
src (module).
- Public Interface
- http-request-error (condition).
- request-method (reader method).
- (setf request-method) (writer method).
- request-uri (reader method).
- (setf request-uri) (writer method).
- response-body (reader method).
- (setf response-body) (writer method).
- response-status (reader method).
- (setf response-status) (writer method).
Next: cl-incognia/src/routes.lisp, Previous: cl-incognia/src/error.lisp, Up: Lisp [Contents][Index]
4.1.5 cl-incognia/src/http.lisp
- Dependency
error.lisp (file).
- Source
- Parent Component
src (module).
- Internals
- do-auth-request (macro).
- do-request (macro).
Next: cl-incognia/src/address.lisp, Previous: cl-incognia/src/http.lisp, Up: Lisp [Contents][Index]
4.1.6 cl-incognia/src/routes.lisp
- Dependency
http.lisp (file).
- Source
- Parent Component
src (module).
- Internals
- *authentication-uri* (special variable).
- *feedbacks-uri* (special variable).
- *incognia-br-uri* (special variable).
- *incognia-us-uri* (special variable).
- *signups-uri* (special variable).
- *transactions-uri* (special variable).
Next: cl-incognia/src/config.lisp, Previous: cl-incognia/src/routes.lisp, Up: Lisp [Contents][Index]
4.1.7 cl-incognia/src/address.lisp
- Dependency
routes.lisp (file).
- Source
- Parent Component
src (module).
- Public Interface
- initialize-instance (method).
- make-address (function).
- Internals
- addr-borough (reader method).
- (setf addr-borough) (writer method).
- addr-city (reader method).
- (setf addr-city) (writer method).
- addr-complements (reader method).
- (setf addr-complements) (writer method).
- addr-coordinates-plist (method).
- addr-coordinates-validp (method).
- addr-country-code (reader method).
- (setf addr-country-code) (writer method).
- addr-country-name (reader method).
- (setf addr-country-name) (writer method).
- addr-lat (reader method).
- (setf addr-lat) (writer method).
- addr-line (reader method).
- (setf addr-line) (writer method).
- addr-line-plist (method).
- addr-line-validp (method).
- addr-lng (reader method).
- (setf addr-lng) (writer method).
- addr-locale (reader method).
- (setf addr-locale) (writer method).
- addr-neighborhood (reader method).
- (setf addr-neighborhood) (writer method).
- addr-number (reader method).
- (setf addr-number) (writer method).
- addr-plist (method).
- addr-postal-code (reader method).
- (setf addr-postal-code) (writer method).
- addr-state (reader method).
- (setf addr-state) (writer method).
- addr-street (reader method).
- (setf addr-street) (writer method).
- addr-structured-plist (method).
- addr-structured-validp (method).
- addr-type (reader method).
- (setf addr-type) (writer method).
- addr-validp (method).
- address (class).
- address-type (type).
Next: cl-incognia/src/auth.lisp, Previous: cl-incognia/src/address.lisp, Up: Lisp [Contents][Index]
4.1.8 cl-incognia/src/config.lisp
- Dependency
address.lisp (file).
- Source
- Parent Component
src (module).
- Public Interface
configure (function).
- Internals
- *api-config* (special variable).
- client-id (function).
- client-secret (function).
- credentials (function).
- incognia-uri (function).
- region (function).
- region-type (type).
- us-regionp (function).
Next: cl-incognia/src/main.lisp, Previous: cl-incognia/src/config.lisp, Up: Lisp [Contents][Index]
4.1.9 cl-incognia/src/auth.lisp
- Dependency
config.lisp (file).
- Source
- Parent Component
src (module).
- Internals
- *auth-token* (special variable).
- auth-token-validp (function).
- authenticate (function).
- fetch-auth-token (function).
- request-auth-token (function).
- revoke-auth-token (function).
- set-token-created-at (function).
- token-access-token (function).
- token-created-at (function).
- token-expires-in (function).
- token-type (function).
Previous: cl-incognia/src/auth.lisp, Up: Lisp [Contents][Index]
4.1.10 cl-incognia/src/main.lisp
- Dependency
auth.lisp (file).
- Source
- Parent Component
src (module).
- Public Interface
- get-signup-assessment (function).
- register-login (function).
- register-payment (function).
- register-signup (function).
- send-feedback (function).
- Internals
- feedback-event-type (type).
- register-transaction (function).
Next: Definitions, Previous: Files, Up: The cl-incognia Reference Manual [Contents][Index]
5 Packages
Packages are listed by definition order.
5.1 cl-incognia
- Source
- Nickname
incognia
- Use List
common-lisp.
- Public Interface
- configure (function).
- get-signup-assessment (function).
- http-request-error (condition).
- make-address (function).
- register-login (function).
- register-payment (function).
- register-signup (function).
- request-method (generic reader).
- (setf request-method) (generic writer).
- request-uri (generic reader).
- (setf request-uri) (generic writer).
- response-body (generic reader).
- (setf response-body) (generic writer).
- response-status (generic reader).
- (setf response-status) (generic writer).
- send-feedback (function).
- Internals
- *api-config* (special variable).
- *auth-token* (special variable).
- *authentication-uri* (special variable).
- *feedbacks-uri* (special variable).
- *incognia-br-uri* (special variable).
- *incognia-us-uri* (special variable).
- *signups-uri* (special variable).
- *transactions-uri* (special variable).
- addr-borough (generic reader).
- (setf addr-borough) (generic writer).
- addr-city (generic reader).
- (setf addr-city) (generic writer).
- addr-complements (generic reader).
- (setf addr-complements) (generic writer).
- addr-coordinates-plist (generic function).
- addr-coordinates-validp (generic function).
- addr-country-code (generic reader).
- (setf addr-country-code) (generic writer).
- addr-country-name (generic reader).
- (setf addr-country-name) (generic writer).
- addr-lat (generic reader).
- (setf addr-lat) (generic writer).
- addr-line (generic reader).
- (setf addr-line) (generic writer).
- addr-line-plist (generic function).
- addr-line-validp (generic function).
- addr-lng (generic reader).
- (setf addr-lng) (generic writer).
- addr-locale (generic reader).
- (setf addr-locale) (generic writer).
- addr-neighborhood (generic reader).
- (setf addr-neighborhood) (generic writer).
- addr-number (generic reader).
- (setf addr-number) (generic writer).
- addr-plist (generic function).
- addr-postal-code (generic reader).
- (setf addr-postal-code) (generic writer).
- addr-state (generic reader).
- (setf addr-state) (generic writer).
- addr-street (generic reader).
- (setf addr-street) (generic writer).
- addr-structured-plist (generic function).
- addr-structured-validp (generic function).
- addr-type (generic reader).
- (setf addr-type) (generic writer).
- addr-validp (generic function).
- address (class).
- address-type (type).
- auth-token-validp (function).
- authenticate (function).
- client-id (function).
- client-secret (function).
- credentials (function).
- do-auth-request (macro).
- do-request (macro).
- feedback-event-type (type).
- fetch-auth-token (function).
- incognia-uri (function).
- parse-json (function).
- plist-remove-null-values (function).
- region (function).
- region-type (type).
- register-transaction (function).
- request-auth-token (function).
- revoke-auth-token (function).
- set-token-created-at (function).
- to-json (function).
- token-access-token (function).
- token-created-at (function).
- token-expires-in (function).
- token-type (function).
- us-regionp (function).
Next: Indexes, Previous: Packages, Up: The cl-incognia Reference Manual [Contents][Index]
6 Definitions
Definitions are sorted by export status, category, package, and then by lexicographic order.
Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]
6.1 Public Interface
Next: Generic functions, Previous: Public Interface, Up: Public Interface [Contents][Index]
6.1.1 Ordinary functions
- Function: configure (&key client-id client-secret region) ¶
-
- Package
- Source
- Function: get-signup-assessment (&key signup-id) ¶
-
- Package
- Source
- Function: make-address (&key line lat lng locale country-code country-name state city borough neighborhood number complements street postal-code type) ¶
-
- Package
- Source
- Function: register-login (&key installation-id account-id app-id) ¶
-
- Package
- Source
- Function: register-payment (&key installation-id account-id app-id addresses) ¶
-
- Package
- Source
- Function: register-signup (&key installation-id address app-id) ¶
-
- Package
- Source
- Function: send-feedback (&key timestamp event installation-id account-id) ¶
-
- Package
- Source
Next: Standalone methods, Previous: Ordinary functions, Up: Public Interface [Contents][Index]
6.1.2 Generic functions
- Generic Reader: request-method (condition) ¶
- Generic Writer: (setf request-method) (condition) ¶
-
- Package
- Methods
- Reader Method: request-method ((condition http-request-error)) ¶
- Writer Method: (setf request-method) ((condition http-request-error)) ¶
-
- Source
- Target Slot
- Generic Reader: request-uri (condition) ¶
- Generic Writer: (setf request-uri) (condition) ¶
-
- Package
- Methods
- Reader Method: request-uri ((condition http-request-error)) ¶
- Writer Method: (setf request-uri) ((condition http-request-error)) ¶
-
- Source
- Target Slot
- Generic Reader: response-body (condition) ¶
- Generic Writer: (setf response-body) (condition) ¶
-
- Package
- Methods
- Reader Method: response-body ((condition http-request-error)) ¶
- Writer Method: (setf response-body) ((condition http-request-error)) ¶
-
- Source
- Target Slot
- Generic Reader: response-status (condition) ¶
- Generic Writer: (setf response-status) (condition) ¶
-
- Package
- Methods
- Reader Method: response-status ((condition http-request-error)) ¶
- Writer Method: (setf response-status) ((condition http-request-error)) ¶
-
- Source
- Target Slot
Next: Conditions, Previous: Generic functions, Up: Public Interface [Contents][Index]
6.1.3 Standalone methods
Previous: Standalone methods, Up: Public Interface [Contents][Index]
6.1.4 Conditions
- Condition: http-request-error ¶
-
- Package
- Source
- Direct superclasses
error.
- Direct methods
- Direct slots
- Slot: response-status ¶
-
- Initform
(quote nil)
- Initargs
:response-status
- Readers
- Writers
- Slot: response-body ¶
-
- Initform
(quote nil)
- Initargs
:response-body
- Readers
- Writers
- Slot: request-uri ¶
-
- Initform
(quote nil)
- Initargs
:request-uri
- Readers
- Writers
- Slot: request-method ¶
-
- Initform
(quote nil)
- Initargs
:request-method
- Readers
- Writers
Previous: Public Interface, Up: Definitions [Contents][Index]
6.2 Internals
6.2.1 Special variables
- Special Variable: *api-config* ¶
-
- Package
- Source
- Special Variable: *auth-token* ¶
-
- Package
- Source
- Special Variable: *authentication-uri* ¶
-
- Package
- Source
- Special Variable: *feedbacks-uri* ¶
-
- Package
- Source
- Special Variable: *incognia-br-uri* ¶
-
- Package
- Source
- Special Variable: *incognia-us-uri* ¶
-
- Package
- Source
- Special Variable: *signups-uri* ¶
-
- Package
- Source
- Special Variable: *transactions-uri* ¶
-
- Package
- Source
Next: Ordinary functions, Previous: Special variables, Up: Internals [Contents][Index]
6.2.2 Macros
- Macro: do-auth-request (&key uri method body) ¶
-
- Package
- Source
- Macro: do-request (&key uri method body basic-auth headers parse-response) ¶
-
- Package
- Source
Next: Generic functions, Previous: Macros, Up: Internals [Contents][Index]
6.2.3 Ordinary functions
- Function: auth-token-validp () ¶
-
- Package
- Source
- Function: authenticate () ¶
-
- Package
- Source
- Function: client-id () ¶
-
- Package
- Source
- Function: client-secret () ¶
-
- Package
- Source
- Function: credentials () ¶
-
- Package
- Source
- Function: fetch-auth-token () ¶
-
- Package
- Source
- Function: incognia-uri (resource-uri) ¶
-
- Package
- Source
- Function: parse-json (alist) ¶
-
- Package
- Source
- Function: plist-remove-null-values (plist &optional remove-in-depth) ¶
-
- Package
- Source
- Function: region () ¶
-
- Package
- Source
- Function: register-transaction (&key installation-id account-id type app-id addresses) ¶
-
- Package
- Source
- Function: request-auth-token () ¶
-
- Package
- Source
- Function: revoke-auth-token () ¶
-
- Package
- Source
- Function: set-token-created-at (&key token created-at) ¶
-
- Package
- Source
- Function: to-json (plist) ¶
-
- Package
- Source
- Function: token-access-token (&optional token) ¶
-
- Package
- Source
- Function: token-created-at (&optional token) ¶
-
- Package
- Source
- Function: token-expires-in (&optional token) ¶
-
- Package
- Source
- Function: token-type (&optional token) ¶
-
- Package
- Source
- Function: us-regionp () ¶
-
- Package
- Source
Next: Classes, Previous: Ordinary functions, Up: Internals [Contents][Index]
6.2.4 Generic functions
- Generic Reader: addr-borough (object) ¶
- Generic Writer: (setf addr-borough) (object) ¶
- Generic Reader: addr-city (object) ¶
- Generic Writer: (setf addr-city) (object) ¶
- Generic Reader: addr-complements (object) ¶
- Generic Writer: (setf addr-complements) (object) ¶
- Generic Function: addr-coordinates-plist (obj) ¶
- Generic Function: addr-coordinates-validp (obj) ¶
- Generic Reader: addr-country-code (object) ¶
- Generic Writer: (setf addr-country-code) (object) ¶
- Generic Reader: addr-country-name (object) ¶
- Generic Writer: (setf addr-country-name) (object) ¶
- Generic Reader: addr-lat (object) ¶
- Generic Writer: (setf addr-lat) (object) ¶
- Generic Reader: addr-line (object) ¶
- Generic Writer: (setf addr-line) (object) ¶
- Generic Function: addr-line-plist (obj) ¶
- Generic Function: addr-line-validp (obj) ¶
- Generic Reader: addr-lng (object) ¶
- Generic Writer: (setf addr-lng) (object) ¶
- Generic Reader: addr-locale (object) ¶
- Generic Writer: (setf addr-locale) (object) ¶
- Generic Reader: addr-neighborhood (object) ¶
- Generic Writer: (setf addr-neighborhood) (object) ¶
- Generic Reader: addr-number (object) ¶
- Generic Writer: (setf addr-number) (object) ¶
- Generic Reader: addr-postal-code (object) ¶
- Generic Writer: (setf addr-postal-code) (object) ¶
- Generic Reader: addr-state (object) ¶
- Generic Writer: (setf addr-state) (object) ¶
- Generic Reader: addr-street (object) ¶
- Generic Writer: (setf addr-street) (object) ¶
- Generic Function: addr-structured-plist (obj) ¶
- Generic Function: addr-structured-validp (obj) ¶
- Generic Reader: addr-type (object) ¶
- Generic Writer: (setf addr-type) (object) ¶
Next: Types, Previous: Generic functions, Up: Internals [Contents][Index]
6.2.5 Classes
- Class: address ¶
-
- Package
- Source
- Direct methods
- (setf addr-borough).
- addr-borough.
- (setf addr-city).
- addr-city.
- (setf addr-complements).
- addr-complements.
- addr-coordinates-plist.
- addr-coordinates-validp.
- (setf addr-country-code).
- addr-country-code.
- (setf addr-country-name).
- addr-country-name.
- (setf addr-lat).
- addr-lat.
- (setf addr-line).
- addr-line.
- addr-line-plist.
- addr-line-validp.
- (setf addr-lng).
- addr-lng.
- (setf addr-locale).
- addr-locale.
- (setf addr-neighborhood).
- addr-neighborhood.
- (setf addr-number).
- addr-number.
- addr-plist.
- (setf addr-postal-code).
- addr-postal-code.
- (setf addr-state).
- addr-state.
- (setf addr-street).
- addr-street.
- addr-structured-plist.
- addr-structured-validp.
- (setf addr-type).
- addr-type.
- addr-validp.
- initialize-instance.
- Direct slots
- Slot: line ¶
-
- Initargs
:line
- Readers
- Writers
- Slot: lat ¶
-
- Initargs
:lat
- Readers
- Writers
- Slot: lng ¶
-
- Initargs
:lng
- Readers
- Writers
- Slot: locale ¶
-
- Initargs
:locale
- Readers
- Writers
- Slot: country-code ¶
-
- Initargs
:country-code
- Readers
- Writers
- Slot: country-name ¶
-
- Initargs
:country-name
- Readers
- Writers
- Slot: state ¶
-
- Initargs
:state
- Readers
- Writers
- Slot: city ¶
-
- Initargs
:city
- Readers
- Writers
- Slot: borough ¶
-
- Initargs
:borough
- Readers
- Writers
- Slot: neighborhood ¶
-
- Initargs
:neighborhood
- Readers
- Writers
- Slot: number ¶
-
- Package
common-lisp.
- Initargs
:number
- Readers
- Writers
- Slot: complements ¶
-
- Initargs
:complements
- Readers
- Writers
- Slot: street ¶
-
- Initargs
:street
- Readers
- Writers
- Slot: postal-code ¶
-
- Initargs
:postal-code
- Readers
- Writers
- Slot: type ¶
-
- Package
common-lisp.
- Initform
:|home|
- Initargs
:type
- Readers
- Writers
Previous: Definitions, Up: The cl-incognia Reference Manual [Contents][Index]
Appendix A Indexes
A.2 Functions
| 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]
A.3 Variables
| Jump to: | *
B C L N P R S T |
|---|
| Jump to: | *
B C L N P R S T |
|---|
A.4 Data types
| 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 |
|---|