Authentication
Authenticate the Mobile API with your access key to use the available resources.
Last updated
Authenticate the Mobile API with your access key to use the available resources.
Last updated
To access CAF resources using this REST API, you will first need a Mobile Key. This is a token that CAF provides for authorization and is used by the client when making each API call.
API keys are a secret that only the client and CAF know. Like Basic authentication, API key-based authentication is only considered secure if used together with other security mechanisms such as HTTPS/SSL.
Account users with appropriate permissions will be able to retrieve or create their mobile key from the Trust Platform by following the below steps:
Once logged into the , click on the setting button (gear icon) within the client navigation area and then select "API Integration" from the options.
Ensure the active tab is "Mobile Keys", on this page you can see your keys and the linked products. Click "copy" to save to your clipboard.
To create a new one, click on the "New key" button and select which products the token will be allowed to run and a name for the key, then click on "Generate key". The page will show you clientId
and clientSecret
, keep it safe.
Don’t store your keys directly on your mobile application. Does this turn trivial for one attacker to realize reverse engineering on your application and get these informations. In this case, the attacker can realize requests fraudulently in your name, compromising the security of your application and causing undue charges.
The following steps describe how can you generate tokens that are only valid for a specific user. This is the recommended way to generate and distribute the tokens because it limits a possible attack on a single user account.
At some point in your application flow, create a JWT with the structure of the example below;
Remember to replace the fields {clientId}
, {peopleId}
and {expiresAt}
All fields are highly recommended, you can see which one is required at the bottom of this page
Sign the token with your clientSecret
;
Use this token to authenticate API or SDK calls.
Keep the Header
field, do not change;
Edit the payload, only the iss
field is required;
Replace your-256-bit-secret
with your clientSecret
;
Go to Share JWT to copy the generated token to the clipboard;
Use this token to authenticate API or SDK calls.
Parameter
Required
Description
iss
Yes
Your clientId
exp
No
peopleId
No
The CPF (Individual Taxpayer Registration Number) in which the token will be valid
Go to the website ;
Expiration time (seconds time)