The first step of verifying a user is sending the basic data of the user to the server.
Post to: https://api.basisid.com/auth/base-check
Query parameters:
- Key (string) - Required
BASIS ID API Key from CRM - My Cabinet - API Access.
Example: "prod-pHmeBukoXXXXXpXFjOhvjmrXxwwbtZOn"
2. First_name (string) - Required
User's first name.
Example: "John".
3. Last_name (string) - Required
User's last name.
Example: "Doe"
4. Middle_name (string)
User's middle name.
Example: "Young".
5. Email (string) - Required
User's email address.
Example: "test123@testmail.com".
6. Phone (string) - Required
The phone number of the user in the following format [country code]-[phone number].
Example: "7-9181234567".
7. Phone2 (string)
Additional phone number of the user in the following format [country code]-[phone number].
8. Gender (number)
Gender, 0 - male, 1 - female, 2 - other.
9. Birthday_day (string) - Required
User's day of birth (valid day number, 1-31).
10. Birthday_month (string) - Required
User's month of birth (1 - January .. 12 - December).
11. Birthday_year (string) - Required
User's year of birth, valid year number, from 1917 to current year.
12. Country_nationality (string) - Required
Country of citizenship, iso2 code.
13. Country_residence (string)
Country of residence, iso2 code.
14. City (string)
Name of the City.
15. Address (string)
Address of living.
16. Address2 (string)
Additional address.
17. Zip (string)
Index code of the address.
Example:
curl \
-H "Content-Type: application/json" \
-X POST -d '{
"key": "prod-pHmeBukoXXXXXpXFjOhvjmrXxwwbtZOn",
"first_name": "John",
"last_name": "Doe",
"middle_name": "Young",
"email": "test123@testmail.com",
"phone": "7-9181234567",
"phone2": "", "gender": 0,
"birthday_day": "01",
"birthday_month": "07",
"birthday_year": "1983",
"country_nationality": "SG",
"country_residence": "SG",
"city": "Singapore",
"address": "Last Street, 19-99",
"zip": "54321"
}' \
https://api.basisid.com/auth/base-check
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. Value: ok
2. User_Hash (string) - Required
Unique user hash.
3. Check_Id (string) - Required
Unique user ID.
4. Api_access_token (string) - Required
Token to retrieve user data through a server-side API. The lifetime of the token is 60 minutes.
5. Api_refresh_token (string) - Required
Token for updating user data through a server-side API.
6. Blockchain_read_token (string)
Token for blockchain interactions. Functionality is under development and is currently unavailable.
Example:
{
"api_access_token":"aat-f45ed412-aea8-4e05-855e-2e0f6bc9ec78",
"api_refresh_token":"art-8014f6f6-2e10-408f-8c8e-8183bf1be21a",
"blockchain_read_token":"",
"status":"ok",
"user_hash":"b15966f2-edee-41f2-abbf-8cffc5ea7668",
"user_id":35652
}
Status 200 Bad system response:
- Status (string) - Required
Request status. Value: bad
2. Errors (string) - Required
Error code.
Error values:
"error:key" – API_KEY is not specified.
"empty:first_name" – first name is not specified.
"empty:last_name" – last name is not specified.
"empty:phone" – phone number is not specified.
"empty:email" – e-mail is not specified.
"empty:birthday_day" – date of birth is empty or has an invalid number.
"empty:birthday_month" – month of birth is empty or has an invalid number.
"empty:birthday_year" – year of birth is empty or has an invalid number.
"empty:country_nationality" - citizenship is empty or in a wrong format.
"empty:country_residence" – country of residence is empty or in a wrong format.
"empty:city" – city is not specified
"empty:address" – address is not specified
"user:exists" – user with this e-mail/phone number already exists"
*Possible responses depending on the system settings.
Example:
{
"status":"bad",
"errors":["empty:first_name"]
}
Comments
0 comments
Please sign in to leave a comment.