Before to get Auth, you must have an ORG.
Logs in a user. Returns the person information and a JSON Web Token for secured calls.
- Request Example:
after submitting a request a typical response is shown below
- Example Response (JSON)
The value of the field ‘token’ from the response needs to be included in all the calls to the API.
JOB API need Token for secured calls. You can generated it manually in your org’s admin section
JOB API Auth :
Generate API KEY
Step 1:
Logs with your org user and select “admin” into menu option
Step 2
Select the option API KEY
Step 3:
Click in “ADD A NEW API KEY”
Step 4:
Set your API KEY ROLES and write a name for your api-key and click at the button “GENERATE”
Last Step:
Copy your KEY and now, you are ready started to use JOB API
JOB API Request and Response
Job API is Asynchronous, you should verify your callback URL.
Request:
Parameters
| Parameter | Type | Required | Description |
| name | string | true | Name |
| surname | string | true | Surname |
| gender | string | true | Gender. Can be MALE or FEMALE |
| nationality | string | true | Nationality in 3 character ISO 3116-1 format |
| address | string | false | Address |
| addressCity | string | false | Address City |
| addressState | string | false | Address State |
| addressZipCode | string | false | Address Zip Code (Post code) |
| addressCountry | string | false | Address Country |
| birthDate | string(date-time) | false | Date of birth |
| string | true | ||
| phone | string | false | Phone number |
| documentId | string | false | ID of the document |
| documentType | string | false | Type of document. Can be NATIONAL_ID or PASSPORT |
| documentIssueDate | string(date-time) | false | Document issue date |
| documentExpirationDate | string(date-time) | false | Document expiration date |
| callback | string | false | Insert here the URL of your service to be automatically invoked when the job finishes. The information will be sent as a POST request, like shown in the screenshot below |
| expiration | string(date-time) | false | Expiration date of the job. It will be deleted on the chosen date |
| documents | [Object Document] | false | Object Document |
API Callback response
This callback will send back the job id. Then you will need to call the endpoint Get a Job Information to get the rest of the job.