Authorizations
The authentication system on Partoo API is using API Key that should be put in the header of the request (the name of the header is x-APIKey
). An api_key is linked to a user. This user's role will give you different access level to the API features.
Path Parameters
Google location unique id on Partoo
Body
SMS
, PHONE_CALL
, EMAIL
, ADDRESS
REQUIRED for SMS
and PHONE_CALL
methods. The phone number to which the code will be send.
"+33187662490"
REQUIRED for EMAIL
method. The email address to which the code will be send.
"email.api@partoo.fr"
REQUIRED for ADDRESS
method. The full name to which the postcard will be send.
"John Doe"
Response
OK
The status of the response success
or error
.
"success"
OPTIONAL Details of the error encountered. Can be one of the following:
start_no_verification_found
: No verification request has been started.start_error
: An error occured during the start of the verification process.
start_no_verification_found
, start_error
null