Get an Agent Verification Status

The Get an Agent Verification Status API allows you to retrieve the current verification status of an agent based on agent number, indicating whether the agent is verified or not.

Prerequisites

After you sign up, your account will be on the trial version. You must complete the KYC to access all the features in kaleyra.io.
Before you get started, Create an API Key. To view the API Key and the SID, see View API Key and SID.
Before sending the RCS, you must configure the RCS channel in the Kaleyra platform. To configure the RCS channel in your account, please contact your local Kaleyra representative.

Base URL

URL	Region
`https://rcs-api.<pod>.kaleyra.io`	For North America (NA).
`https://rcs-api.<pod>.kaleyra.io`	For the rest of the world.

API Domain and Value

api_domain	Value
IN pod	`https://rcs-api.in.kaleyra.io`
NA pod	`https://rcs-api.na.kaleyra.io`

API request to get an Agent Verification Status

To get an agent verification status, use the https://rcs-api.<pod>.kaleyra.io/v1/<sid>/rcs/agentstatus?agent_number={agent_number} endpoint with the following request method:

Request Format

The following is the request format to get an agent verification status:

curl --location --request GET 'https://<api_domain>/v1/<sid>/rcs/agentstatus?agent_number=<agent_number>'\
--header 'Content-Type: <content_type>' \
--header 'api-key: <api-key>'

Sample Request Format

The following is the sample request format to get an agent verification status:

curl --location --request GET 'https://rcs-api.na.kaleyra.io/v1/XXXXX6913850XXXX/rcs/agentstatus?agent_number=48400'\
--header 'Content-Type: application/json' \
--header 'api-key: XXXXX3b8497f58a94e84b671aca43XXXX'

URL Parameters and Headers

The following is the list of parameters and headers to send the outgoing message request:

Parameter/Headers	Data Type	Description	Example	Mandatory?
`sid`	String	Account SID (Security Identifier).	XXXXX6913850XXXX	Yes
`Content-Type`	String	Indicates the format of the content the API will be processing.	The only allowed value is application/JSON	Yes
`api-key`	String	API key generated from kaleyra.io account.	XXXXX3b8497f58a94e84b671aca43XXXX	Yes

The following is the list of parameters to be used in the payload to get an agent verification status by agent number:

Parameter	Data Type	Description	Example	Mandatory?
`agent_number`	string	Auto generated number by the server at the time of create agent request.	48400	Yes

Sample Success Response

The following is the sample success response:

{
    "code": "RCS902",
    "message": "Agent verification obtained successfully",
    "data": true,
    "error": {}
}

Failure Responses

The following is the list of error codes that you can encounter while getting an agent verification status:

Scenario	HTTP Status	Error Code	Message	Error Code Constant	Error Message
Method Not Allowed	405	RCS405	Method not allowed.	METHOD_NOT_ALLOWED	Method not allowed.
Gateway Error	500	RCS502	Internal Gateway Error	RCS_CHANNEL_INTERNAL_ERROR	Internal Gateway Error.
Internal Server Error	500	RCS500	Internal server error	RCS_CHANNEL_INTERNAL_ERROR	Internal server error.