In order to receive the information about a user's profile and the results of the verification, a request can be sent.
Post to: https://api.basisid.com/users/info/{user_hash}/{api_key}/{signature}
Query parameters:
- User_Hash (string) - Required
Example: "b84caa8cb9097361b89509c7395be1e7f7743442"
User hash
2. API Key (string) - Required
BASIS ID API Key from CRM - My Cabinet - API Access.
Example: "prod-pHmeBukoXXXXXpXFjOhvjmrXxwwbtZOn"
3. Signature (string) - Required
Example: "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08"
Encrypted signature. Calculated as sha256(user_hash + BASIS_API_SECRET2)
Example:
curl \
https://api.basisid.com/users/info/email@example.com/d67b6cd3-7255-4203-b351-3bd26233dcc8/a956bd8dceff54384a065dc6ec183ddf52302e4613e634769cfeebfdc87c1677
Responses:
- 200 Status 200
- 400 Bad request (could not parse JSON input request)
- 500 Internal server error (contact support team)
Status 200 OK system response:
- Status (string) - Required
Request status "ok" - No errors found.
2. User_status (number) - Required
User status
3. Basis_status (number) - Required
BASIS ID status
4. Autocheck_status (number) Required
User profile auto verification status
5. Profile summary (profile) Required
User profile information (see below)
Profile summary structure:
id |
string user unique id |
user_hash |
string user hash |
first_name |
string first name |
last_name |
string last name |
middle_name |
string middle name |
|
string email address |
email_confirmed |
bool email address confirmed flag |
phone |
string phone number |
phone2 |
string additional phone number |
gender |
string gender |
address |
string address line1 |
address2 |
string address line2 |
autocheck_bad_reasons |
string the reason for the request to be automatically declined |
birthday |
String date of birth, YYYY-MM-DD |
city |
string city |
country |
string country code, ISO2 |
country_residence |
string residence country code, ISO2 |
zip |
string postcode |
Example:
{
"status": "ok",
"profile":
{
"id": "9142",
"user_hash": "222fc57c643d5dd86bb473ee729a52c95476fea3",
"address": "address",
"address2": "",
"autocheck_bad_reasons": "0",
"birthday": "1990-07-14",
"city": "City",
"country": "country iso-2",
"country_residence": "country",
"email": "john@smith.com",
"email_confirmed": "true",
"first_name": "John",
"last_name": "Smith",
"gender": "male",
"middle_name": "",
"phone": "110011212",
"phone2": "",
"zip": "12345"
},
"user_status": 11,
"basis_status": 10,
"autocheck_status": 0
}
Statuses:
0 – waiting
3 – requested
10 – confirmed
11 – declined
Status 200 Bad system response:
Error statuses:
"company_not_found" - company not found.
"wrong_signature" - wrong signature
"user_not_found" - user with defined user hash or email not found
Example:
{
"status":"user_not_found"
}
Comments
0 comments
Please sign in to leave a comment.