def get_user_token(self, email: str, verbose: bool = False) -> Response:
"""
Returns user token linked to Onboarding User managed by the Sandbox Service
Parameters
----------
email
User's email
verbose
Used for print service response as well as the time elapsed
Returns
-------
A Response object [requests library]
"""
print_intro("get_user_token", verbose=verbose)
headers = self._auth_headers(self.sandbox_token)
response = request("GET",
self.url + f"/user/token/{email}",
headers=headers)
print_response(response=response, verbose=verbose)
return response
def deauthorize_user(self, user_id: str, verbose: bool = False) -> Response:
"""
Deauthorizes a user. Now it cannot be authenticate.
Parameters
----------
user_id
User identifier
verbose
Used for print service response as well as the time elapsed
Returns
-------
A Response object [requests library]
"""
print_intro("deauthorize_user", verbose=verbose)
backend_user_token = self.auth.create_backend_token(user_id=user_id).unwrap()
print_token("backend_token_with_user", backend_user_token, verbose=verbose)
headers = self._auth_headers(backend_user_token)
response = request("POST", self.url + "/user/deauthorize", headers=headers)
print_response(response=response, verbose=verbose)
return response
def retrieve_certificates(self, user_id: str, verbose: bool = False) -> Response:
"""
Returns summary info for created certificates
Parameters
----------
user_id
User identifier
verbose
Used for print service response as well as the time elapsed
Returns
-------
A Response object [requests library]
"""
print_intro("retrieve_certificates", verbose=verbose)
backend_user_token = self.auth.create_backend_token(user_id=user_id).unwrap()
print_token("backend_token_with_user", backend_user_token, verbose=verbose)
headers = self._auth_headers(backend_user_token)
response = request("GET", f"{self.url}/user/certificates", headers=headers)
print_response(response=response, verbose=verbose)
return response
def get_authentications_ids(self, user_id: str, verbose: bool = False) -> Response:
"""
Returns all authentication you have performed for a User, sorted by creation date in descending order.
Parameters
----------
user_id
User identifier
verbose
Used for print service response as well as the time elapsed
Returns
-------
A Response object [requests library]
"""
print_intro("get_authentications_ids", verbose=verbose)
backend_user_token = self.auth.create_backend_token(user_id=user_id).unwrap()
print_token("backend_token_with_user", backend_user_token, verbose=verbose)
headers = self._auth_headers(backend_user_token)
response = request(
"GET", self.url + "/user/authentications/ids", headers=headers
)
print_response(response=response, verbose=verbose)
return response
def supported_documents(self, user_id: str, verbose: bool = False) -> Response:
"""
This method is used to obtain a hierarchical-ordered dict with the information of the documents supported by the API.
Parameters
----------
user_id
User identifier
verbose
Used for print service response as well as the time elapsed
Returns
-------
A Response object [requests library]
"""
print_intro("supported_documents", verbose=verbose)
user_token = self.auth.create_user_token(user_id).unwrap()
print_token("user_token", user_token, verbose=verbose)
headers = self._auth_headers(user_token)
response = request("GET", self.url + "/documents/supported", headers=headers)
print_response(response=response, verbose=verbose)
return response
def create_report(self, user_id: str, verbose: bool = False) -> Response:
"""
This call is used to get the report of the onboarding process for a specific user.
It returns information on all evidence that has been added and analyzed for that user,
including documents and facial verifications.
Parameters
----------
user_id
User identifier
verbose
Used for print service response as well as the time elapsed
Returns
-------
A Response object [requests library]
"""
print_intro("create_report", verbose=verbose)
backend_user_token = self.auth.create_backend_token(user_id=user_id).unwrap()
print_token("backend_token_with_user", backend_user_token, verbose=verbose)
headers = self._auth_headers(backend_user_token)
response = request("GET", self.url + "/user/report", headers=headers)
print_response(response=response, verbose=verbose)
return response
def void_selfie(self, user_id: str, verbose: bool = False) -> Response:
"""
This call is used to void the video of the user's face to the onboarding service.
This will NOT erase the biometric face profile.
Parameters
----------
user_id
User identifier
verbose
Used for print service response as well as the time elapsed
Returns
-------
A Response object [requests library]
"""
print_intro("void_selfie", verbose=verbose)
backend_token = self.auth.create_backend_token(user_id).unwrap()
print_token("backend_token_with_user", backend_token, verbose=verbose)
headers = self._auth_headers(backend_token)
response = request("PATCH", self.url + "/user/selfie", headers=headers)
print_response(response=response, verbose=verbose)
return response
def get_users_stats(self, verbose: bool = False) -> Response:
"""
Returns statistics about users in the Onboarding platform.
Parameters
----------
verbose
Used for print service response as well as the time elapsed
Returns
-------
A Response object [requests library]
"""
print_intro("get_users_stats", verbose=verbose)
backend_token = self.auth.create_backend_token().unwrap()
print_token("backend_token", backend_token, verbose=verbose)
headers = self._auth_headers(backend_token)
response = request("GET", self.url + "/users/stats", headers=headers)
print_response(response=response, verbose=verbose)
return response
def get_users(self, verbose: bool = False) -> Response:
"""
Returns all users you have created, sorted by creation date in descending order.
Parameters
----------
verbose
Used for print service response as well as the time elapsed
Returns
-------
A Response object [requests library]
"""
print_intro("get_users", verbose=verbose)
backend_token = self.auth.create_backend_token().unwrap()
print_token("backend_token", backend_token, verbose=verbose)
headers = self._auth_headers(backend_token)
response = request("GET", self.url + "/users", headers=headers)
print_response(response=response, verbose=verbose)
return response
def delete_user(self, user_id: str, verbose: bool = False) -> Response:
"""
Delete all the information of a user
Parameters
----------
user_id
User identifier
verbose
Used for print service response as well as the time elapsed
Returns
-------
A Response object [requests library]
"""
print_intro("delete_user", verbose=verbose)
backend_token = self.auth.create_backend_token(user_id).unwrap()
print_token("backend_token_with_user", backend_token, verbose=verbose)
headers = self._auth_headers(backend_token)
response = request("DELETE", self.url + "/user", headers=headers)
print_response(response=response, verbose=verbose)
return response
def get_user_status(self, user_id: str, verbose: bool = False) -> Response:
"""
Returns User status to be used as feedback from the onboarding process
Parameters
----------
user_id
User identifier
verbose
Used for print service response as well as the time elapsed
Returns
-------
A Response object [requests library]
"""
print_intro("get_user_status", verbose=verbose)
user_token = self.auth.create_user_token(user_id).unwrap()
print_token("user_token", user_token, verbose=verbose)
headers = self._auth_headers(user_token)
response = request("GET", self.url + "/user/status", headers=headers)
print_response(response=response, verbose=verbose)
return response
def retrieve_media(
self, user_id: str, media_id: str, verbose: bool = False
) -> Response:
"""
Returns the binary data of a media resource
Parameters
----------
user_id
User identifier
media_id
Identifier obtained, for example from the report
verbose
Used for print service response as well as the time elapsed
Returns
-------
A Response object [requests library]
"""
print_intro("retrieve_media", verbose=verbose)
backend_user_token = self.auth.create_backend_token(user_id=user_id).unwrap()
print_token("backend_token_with_user", backend_user_token, verbose=verbose)
headers = self._auth_headers(backend_user_token)
response = request(
"GET", self.url + "/media/{}/download".format(media_id), headers=headers
)
print_response(response=response, verbose=verbose)
return response
def delete_user(self, email: str, verbose: bool = False) -> Response:
"""
Delete all the information of a user
Parameters
----------
email
User's email
verbose
Used for print service response as well as the time elapsed
Returns
-------
A Response object [requests library]
"""
print_intro("delete_user", verbose=verbose)
headers = self._auth_headers(self.sandbox_token)
response = request("DELETE",
self.url + f"/user/{email}",
headers=headers)
print_response(response=response, verbose=verbose)
return response
def retrieve_certificate(
self, user_id: str, certificate_id: str, verbose: bool = False
) -> Response:
"""
This call is used to retrieve a Certificate (Signed PDF Report) of the onboarding process for a specific user.
This resource contains all evidence defined in the template.
Parameters
----------
user_id
User identifier
certificate_id
Certificate Unique Identifier
verbose
Used for print service response as well as the time elapsed
Returns
-------
A Response object [requests library]
"""
print_intro("retrieve_certificate", verbose=verbose)
backend_user_token = self.auth.create_backend_token(user_id=user_id).unwrap()
print_token("backend_token_with_user", backend_user_token, verbose=verbose)
headers = self._auth_headers(backend_user_token)
response = request(
"GET", f"{self.url}/user/certificate/{certificate_id}", headers=headers
)
print_response(response=response, verbose=verbose)
return response
def get_user(self, email: str, verbose: bool = False) -> Response:
"""
Returns User status to be used as feedback from the onboarding process
Parameters
----------
email
User's email
verbose
Used for print service response as well as the time elapsed
Returns
-------
A Response object [requests library]
"""
print_intro("get_user", verbose=verbose)
headers = self._auth_headers(self.sandbox_token)
response = request("GET", self.url + f"/user/{email}", headers=headers)
print_response(response=response, verbose=verbose)
return response
def add_document(
self,
user_id: str,
document_id: str,
media_data: bytes,
side: str,
manual: bool = False,
fields: dict = None,
verbose: bool = False,
) -> Response:
"""
This call is used to upload for the first time the photo or video of a document to the onboarding service.
From a given media, the platform automatically saves the document content.
Parameters
----------
user_id
User identifier
document_id
Document identifier
media_data
Binary media data.
side
Side of the document [front or back]
manual
If True defines manual document uploading
fields
Fields to add regardless of the OCR process
verbose
Used for print service response as well as the time elapsed
Returns
-------
A Response object [requests library]
"""
print_intro("add_document", verbose=verbose)
user_token = self.auth.create_user_token(user_id).unwrap()
print_token("user_token", user_token, verbose=verbose)
headers = self._auth_headers(user_token)
data = {
"document_id": document_id,
"side": side,
"manual": manual,
"fields": json.dumps(fields),
}
files = {"image": ("image", media_data)}
response = request(
"PUT", self.url + "/user/document", files=files, data=data, headers=headers
)
print_response(response=response, verbose=verbose)
return response
def get_authentications(
self,
user_id: str,
page: int = 1,
page_size: int = 0,
descending: bool = True,
verbose: bool = False,
) -> Response:
"""
Returns all authentications you have performed for a User.
Parameters
----------
user_id
User identifier
page
Page from which authentications will be returned. Default 1.
page_size
Numbers of authentications that will be returned for each page. To return all the authentications select 0.
descending
Order of the authentications according to their creation date.
verbose
Used for print service response as well as the time elapsed
Returns
-------
A Response object [requests library]
"""
print_intro("get_authentications", verbose=verbose)
backend_user_token = self.auth.create_backend_token(user_id=user_id).unwrap()
print_token("backend_token_with_user", backend_user_token, verbose=verbose)
headers = self._auth_headers(backend_user_token)
url_query_params = (
f"?page={str(page)}&page_size={str(page_size)}&descending={str(descending)}"
)
response = request(
"GET",
self.url + "/user/authentications" + url_query_params,
headers=headers,
)
print_response(response=response, verbose=verbose)
return response
def create_user(
self,
user_info: UserInfo = None,
device_info: DeviceInfo = None,
verbose: bool = False,
) -> Response:
"""
It creates a new User in the onboarding service.
You must create a User before you start the onboarding flow.
Parameters
----------
user_info
Object with optional values with info about the User.
device_info
Object with optional values with info about the User's Device.
verbose
Used for print service response as well as the time elapsed
Returns
-------
A Response object [requests library]
"""
print_intro("create_user", verbose=verbose)
backend_token = self.auth.create_backend_token().unwrap()
print_token("backend_token", backend_token, verbose=verbose)
headers = self._auth_headers(backend_token)
data = None
if user_info:
data = data if data is not None else {}
data.update(json.loads(user_info.to_json()))
if device_info:
data = data if data is not None else {}
data.update(json.loads(device_info.to_json()))
response = request("POST", self.url + "/user", headers=headers, data=data)
print_response(response=response, verbose=verbose)
return response
def create_user(
self,
user_info: UserInfo = None,
device_info: DeviceInfo = None,
verbose: bool = False,
) -> Response:
"""
It creates a new User in the sandbox service.
Parameters
----------
user_info
Object with optional values with info about the User.
device_info
Object with optional values with info about the User's Device.
verbose
Used for print service response as well as the time elapsed
Returns
-------
A Response object [requests library]
"""
print_intro("create_user", verbose=verbose)
headers = self._auth_headers(self.sandbox_token)
data = None
if user_info:
data = data if data is not None else {}
data.update(json.loads(user_info.to_json()))
if device_info:
data = data if data is not None else {}
data.update(json.loads(device_info.to_json()))
response = request("POST",
self.url + "/user",
headers=headers,
data=data)
print_response(response=response, verbose=verbose)
return response
def create_user_token(self,
service_id: str,
user_id: str,
verbose: bool = False) -> Response:
print_intro("create_user_token", verbose=verbose)
if not self._is_token_valid(self._login_token):
response = self._create_login_token()
if response.status_code == 200:
self._login_token = self._get_token_from_response(response)
else:
return response
final_url = "{}/user_token/{}/{}".format(self.url, service_id, user_id)
headers = {"Authorization": "Bearer {}".format(self._login_token)}
response = requests.get(final_url, headers=headers)
print_response(response=response, verbose=verbose)
return response
def create_certificate(
self, user_id: str, template_name: str = "default", verbose: bool = False
) -> Response:
"""
This call is used to create a Certificate (Signed PDF Report) of the onboarding process for a specific user.
It returns a identifier (certificate_id) as a reference of created resource.
This resource contains all evidence defined in the template.
Parameters
----------
user_id
User identifier
template_name
'default' (only available)
verbose
Used for print service response as well as the time elapsed
Returns
-------
A Response object [requests library]
"""
print_intro("create_certificate", verbose=verbose)
backend_user_token = self.auth.create_backend_token(user_id=user_id).unwrap()
print_token("backend_token_with_user", backend_user_token, verbose=verbose)
options = {"template_name": template_name}
headers = self._auth_headers(backend_user_token)
headers["Content-Type"] = "application/json"
response = request(
"POST",
self.url + "/user/certificate",
data=json.dumps(options),
headers=headers,
)
print_response(response=response, verbose=verbose)
return response
def get_authentication(
self, user_id: str, authentication_id: str, verbose: bool = False
) -> Response:
"""
Gets a information from a previous authentication using the verification_id
Parameters
----------
user_id
User identifier
authentication_id
Authentication identifier.
verbose
Used for print service response as well as the time elapsed
Returns
-------
A Response object [requests library]
"""
print_intro("get_authentication", verbose=verbose)
backend_user_token = self.auth.create_backend_token(user_id=user_id).unwrap()
print_token("backend_token_with_user", backend_user_token, verbose=verbose)
headers = self._auth_headers(backend_user_token)
response = request(
"GET",
self.url
+ "/user/authentication/{authentication_id}".format(
authentication_id=authentication_id
),
headers=headers,
)
print_response(response=response, verbose=verbose)
return response
def healthcheck(self, verbose: bool = False) -> Response:
"""
Runs a healthcheck on the service to see if there are any problems.
Parameters
----------
verbose
Used for print service response as well as the time elapsed
Returns
-------
A Response object [requests library]
"""
print_intro("healthcheck", verbose=verbose)
response = request("GET", self.url + "/healthcheck")
print_response(response=response, verbose=verbose)
return response
def add_selfie(
self, user_id: str, media_data: bytes, verbose: bool = False
) -> Response:
"""
This call is used to upload for the first time the video of the user's face to the onboarding service.
This video will be used to extract the biometric face profile.
Parameters
----------
user_id
User identifier
media_data
Binary media data.
verbose
Used for print service response as well as the time elapsed
Returns
-------
A Response object [requests library]
"""
print_intro("add_selfie", verbose=verbose)
user_token = self.auth.create_user_token(user_id).unwrap()
print_token("user_token", user_token, verbose=verbose)
headers = self._auth_headers(user_token)
files = {"video": ("video", media_data)}
response = request(
"POST", self.url + "/user/selfie", files=files, headers=headers
)
print_response(response=response, verbose=verbose)
return response
def create_document(
self, user_id: str, type: str, issuing_country: str, verbose: bool = False
) -> Response:
"""
This call is used to obtain a new document_id
With this document_id you will be able to extract information with the add_document method
Parameters
----------
user_id
User identifier
type
Type of document [idcard, driverlicense, passport]
issuing_country
Issuing Country
verbose
Used for print service response as well as the time elapsed
Returns
-------
A Response object [requests library]
"""
print_intro("create_document", verbose=verbose)
user_token = self.auth.create_user_token(user_id).unwrap()
print_token("user_token", user_token, verbose=verbose)
headers = self._auth_headers(user_token)
data = {"type": type, "issuing_country": issuing_country}
response = request(
"POST", self.url + "/user/document", data=data, headers=headers
)
print_response(response=response, verbose=verbose)
return response
def authenticate_user(
self, user_id: str, media_data: bytes, verbose: bool = False
) -> Response:
"""
Authenticates a previously registered User against a given media to verify the identity
Parameters
----------
user_id
User identifier
media_data
Binary media data.
verbose
Used for print service response as well as the time elapsed
Returns
-------
A Response object [requests library]
"""
print_intro("authenticate_user", verbose=verbose)
user_token = self.auth.create_user_token(user_id=user_id).unwrap()
print_token("user_token", user_token, verbose=verbose)
headers = self._auth_headers(user_token)
files = {"video": ("video", media_data)}
response = request(
"POST", self.url + "/user/authenticate", files=files, headers=headers
)
print_response(response=response, verbose=verbose)
return response
def document_properties(
self, user_id: str, document_id: str, verbose: bool = False
) -> Response:
"""
Returns the properties of a previously added document, such as face, MRZ or NFC availability
Parameters
----------
user_id
User identifier
document_id
Document identifier
verbose
Used for print service response as well as the time elapsed
Returns
-------
A Response object [requests library]
"""
print_intro("document_properties", verbose=verbose)
user_token = self.auth.create_user_token(user_id).unwrap()
print_token("user_token", user_token, verbose=verbose)
headers = self._auth_headers(user_token)
data = {"document_id": document_id}
response = request(
"POST", self.url + "/user/document/properties", data=data, headers=headers
)
print_response(response=response, verbose=verbose)
return response
def void_document(
self, user_id: str, document_id: str, verbose: bool = False
) -> Response:
"""
Mark a document as invalid.
Parameters
----------
user_id
User identifier
document_id
Document identifier
verbose
Used for print service response as well as the time elapsed
Returns
-------
A Response object [requests library]
"""
print_intro("void_document", verbose=verbose)
backend_token = self.auth.create_backend_token(user_id).unwrap()
print_token("backend_token_with_user", backend_token, verbose=verbose)
headers = self._auth_headers(backend_token)
response = request(
"PATCH",
self.url + "/user/document/{document_id}".format(document_id=document_id),
headers=headers,
)
print_response(response=response, verbose=verbose)
return response
def create_backend_token(self,
service_id: str,
user_id: str = None,
verbose: bool = False) -> Response:
suffix = " (with user)" if user_id else ""
print_intro(f"create_backend_token{suffix}", verbose=verbose)
if not self._is_token_valid(self._login_token):
response = self._create_login_token()
if response.status_code == 200:
self._login_token = self._get_token_from_response(response)
else:
return response
final_url = "{}/backend_token/{}".format(self.url, service_id)
if user_id:
final_url += "/{}".format(user_id)
headers = {"Authorization": "Bearer {}".format(self._login_token)}
response = requests.get(final_url, headers=headers)
print_response(response=response, verbose=verbose)
return response
def delete_document(
self, user_id: str, document_id: str, verbose: bool = False
) -> Response:
"""
Delete all the stored/extracted information from a document
Parameters
----------
user_id
User identifier
document_id
Document identifier
verbose
Used for print service response as well as the time elapsed
Returns
-------
A Response object [requests library]
"""
print_intro("delete_document", verbose=verbose)
backend_token = self.auth.create_backend_token(user_id).unwrap()
print_token("backend_token_with_user", backend_token, verbose=verbose)
headers = self._auth_headers(backend_token)
response = request(
"DELETE",
self.url + "/user/document/{document_id}".format(document_id=document_id),
headers=headers,
)
print_response(response=response, verbose=verbose)
return response
