{ "info": { "name": "User verification API", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "This operation is used to send a verification to the end-user", "description": "This interface is used to send a verification to the end-user by specifying the communication details of the end-ser.", "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "addTokenTo", "value": "header", "type": "string" } ] }, "method": "Post", "header": [ { "key": "Content-Type", "name": "Content-Type", "value": "application\/json", "type": "application\/json", "description": "" } ], "url": { "raw": "api.chenosis.io\/v1\/identity\/verification", "protocol": "https", "host": [ "api", "chenosis", "io" ], "path": { "1": "v1", "2": "identity", "3": "verification" } }, "body": { "mode": "formdata", "formdata": [ { "key": "to", "value": "", "description": "Address of the end-user. If the 'channel' used is 'sms' or 'call' the value is the MSISDN\/phone number of the end-user represented as International ITU-T E.164. If the 'channel' is email, the value would be the email address of the end-user.", "required": 1, "type": "string" }, { "key": "channel", "value": "", "description": "This field is used to set\/indicate the channel used to send the verification code to the end-user.\n The value 'sms' means the verification is sent to the user using an SMS message.\n The value 'call' means the verification is sent to the user via a phone call made to the end-ser.\n The value 'email' means the verification is sent to the user using an email message.", "required": 0, "type": "string" }, { "key": "locale", "value": "", "description": "This field is used to set\/indicate the the language\/locale used when sending the verification code to the end-user. Default is English (en)", "required": 0, "type": "string" } ] } }, "response": [ { "code": 201, "status": "Created", "name": "Outbound SMS created", "schema": { "statusCode": { "type": "string", "description": "HTTP error code extension", "example": "0000" }, "statusMessage": { "type": "string", "description": "Message.", "example": "Successful" }, "data": { "to": { "type": "string", "description": "Address of the end-user. If the 'channel' used is 'sms' or 'call' the value is the MSISDN\/phone number of the end-user represented as International ITU-T E.164. If the 'channel' is email, the value would be the email address of the end-user.", "example": "27123456789" }, "channel": { "type": "string", "default": "", "description": "sms,call,email" }, "verificationId": { "type": "string", "description": "Unique identifier for the verification, this value will be used to query the status of the verification." }, "status": { "type": "string", "default": "", "description": "approved,pending,expired,cancelled" } }, "transactionId": { "type": "string", "description": "transaction ID for tracing.", "example": "fdsf4545-sdfd5-sds" } }, "body": "{\"statusCode\":\"string\",\"statusMessage\":\"string\",\"data\":{\"to\":\"string\",\"channel\":\"string\",\"verificationId\":\"string\",\"status\":\"string\"},\"transactionId\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 401, "status": "Unauthorized", "name": "Not authenticated", "schema": { "statusCode": { "type": "string", "description": "HTTP error code extension" }, "statusMessage": { "type": "string", "description": "More details and corrective actions related to the error which can be shown to a client." }, "SupportMessage": { "type": "string", "description": "Support Message" } }, "body": "{\"statusCode\":\"string\",\"statusMessage\":\"string\",\"SupportMessage\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 404, "status": "Not Found", "name": "Not found", "schema": { "statusCode": { "type": "string", "description": "HTTP error code extension" }, "statusMessage": { "type": "string", "description": "More details and corrective actions related to the error which can be shown to a client." }, "SupportMessage": { "type": "string", "description": "Support Message" } }, "body": "{\"statusCode\":\"string\",\"statusMessage\":\"string\",\"SupportMessage\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 407, "status": "Proxy Authentication Required", "name": "Proxy system not authenticated", "schema": { "statusCode": { "type": "string", "description": "HTTP error code extension" }, "statusMessage": { "type": "string", "description": "More details and corrective actions related to the error which can be shown to a client." }, "SupportMessage": { "type": "string", "description": "Support Message" } }, "body": "{\"statusCode\":\"string\",\"statusMessage\":\"string\",\"SupportMessage\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 500, "status": "Internal Server Error", "name": "Internal Server Error", "schema": { "timestamp": { "type": "string", "description": "Timestamp", "example": "2020-10-14T22:57:24.519+0000" }, "status": { "type": "string", "description": "HTTP error code extension", "example": "500" }, "error": { "type": "string", "description": "Support Message", "example": "Internal Server Error" }, "message": { "type": "string", "description": "Support Message", "example": "value" }, "path": { "type": "string", "description": "Path accessed", "example": "\/v1\/identity\/verification" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] } ] }, { "name": "Get verification", "description": "This interface is used to get the verification status of a verification that was previosly sent using the 'verificationId' to identify it.Please note that if the verification is 'approved', it will not be possible to get the status of the verification.", "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "addTokenTo", "value": "header", "type": "string" } ] }, "method": "Get", "header": [ { "key": "Content-Type", "name": "Content-Type", "value": "application\/json", "type": "application\/json", "description": "" } ], "url": { "raw": "api.chenosis.io\/v1\/identity\/verification\/{verificationId}", "protocol": "https", "host": [ "api", "chenosis", "io" ], "path": { "1": "v1", "2": "identity", "3": "verification", "4": "{verificationId}" } } }, "response": [ { "code": 200, "status": "OK", "name": "Outbound SMS created", "schema": { "statusCode": { "type": "string", "description": "HTTP error code extension", "example": "0000" }, "statusMessage": { "type": "string", "description": "Message.", "example": "Successful" }, "data": { "to": { "type": "string", "description": "Address of the end-user. If the 'channel' used is 'sms' or 'call' the value is the MSISDN\/phone number of the end-user represented as International ITU-T E.164. If the 'channel' is email, the value would be the email address of the end-user.", "example": "27123456789" }, "channel": { "type": "string", "default": "", "description": "sms,call,email" }, "verificationId": { "type": "string", "description": "Unique identifier for the verification, this value will be used to query the status of the verification." }, "status": { "type": "string", "default": "", "description": "approved,pending,expired,cancelled" } }, "transactionId": { "type": "string", "description": "transaction ID for tracing.", "example": "fdsf4545-sdfd5-sds" } }, "body": "{\"statusCode\":\"string\",\"statusMessage\":\"string\",\"data\":{\"to\":\"string\",\"channel\":\"string\",\"verificationId\":\"string\",\"status\":\"string\"},\"transactionId\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 401, "status": "Unauthorized", "name": "Not authenticated", "schema": { "statusCode": { "type": "string", "description": "HTTP error code extension" }, "statusMessage": { "type": "string", "description": "More details and corrective actions related to the error which can be shown to a client." }, "SupportMessage": { "type": "string", "description": "Support Message" } }, "body": "{\"statusCode\":\"string\",\"statusMessage\":\"string\",\"SupportMessage\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 404, "status": "Not Found", "name": "Not found", "schema": { "statusCode": { "type": "string", "description": "HTTP error code extension" }, "statusMessage": { "type": "string", "description": "More details and corrective actions related to the error which can be shown to a client." }, "SupportMessage": { "type": "string", "description": "Support Message" } }, "body": "{\"statusCode\":\"string\",\"statusMessage\":\"string\",\"SupportMessage\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 407, "status": "Proxy Authentication Required", "name": "Proxy system not authenticated", "schema": { "statusCode": { "type": "string", "description": "HTTP error code extension" }, "statusMessage": { "type": "string", "description": "More details and corrective actions related to the error which can be shown to a client." }, "SupportMessage": { "type": "string", "description": "Support Message" } }, "body": "{\"statusCode\":\"string\",\"statusMessage\":\"string\",\"SupportMessage\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 500, "status": "Internal Server Error", "name": "Internal Server Error", "schema": { "timestamp": { "type": "string", "description": "Timestamp", "example": "2020-10-14T22:57:24.519+0000" }, "status": { "type": "string", "description": "HTTP error code extension", "example": "500" }, "error": { "type": "string", "description": "Support Message", "example": "Internal Server Error" }, "message": { "type": "string", "description": "Support Message", "example": "value" }, "path": { "type": "string", "description": "Path accessed", "example": "\/v1\/identity\/verification" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] } ] }, { "name": "Verify a verification", "description": "This interface is used to verify a verification that was previosly sent. The 'code' is sent in order to verify that the correct user received the code. Please note that if the verification is 'approved', it will not be possible to get the status of the verification. The response in this request will be the only time the 'status' will be returned as 'approved' if the code is correct.", "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "addTokenTo", "value": "header", "type": "string" } ] }, "method": "Patch", "header": [ { "key": "Content-Type", "name": "Content-Type", "value": "application\/json", "type": "application\/json", "description": "" } ], "url": { "raw": "api.chenosis.io\/v1\/identity\/verification\/{verificationId}", "protocol": "https", "host": [ "api", "chenosis", "io" ], "path": { "1": "v1", "2": "identity", "3": "verification", "4": "{verificationId}" } }, "body": { "mode": "formdata", "formdata": [ { "key": "code", "value": "", "description": "This is the verification code that was sent to the end-user.", "required": 1, "type": "string" } ] } }, "response": [ { "code": 200, "status": "OK", "name": "Outbound SMS created", "schema": { "statusCode": { "type": "string", "description": "HTTP error code extension", "example": "0000" }, "statusMessage": { "type": "string", "description": "Message.", "example": "Successful" }, "data": { "to": { "type": "string", "description": "Address of the end-user. If the 'channel' used is 'sms' or 'call' the value is the MSISDN\/phone number of the end-user represented as International ITU-T E.164. If the 'channel' is email, the value would be the email address of the end-user.", "example": "27123456789" }, "channel": { "type": "string", "default": "", "description": "sms,call,email" }, "verificationId": { "type": "string", "description": "Unique identifier for the verification, this value will be used to query the status of the verification." }, "status": { "type": "string", "default": "", "description": "approved,pending,expired,cancelled" } }, "transactionId": { "type": "string", "description": "transaction ID for tracing.", "example": "fdsf4545-sdfd5-sds" } }, "body": "{\"statusCode\":\"string\",\"statusMessage\":\"string\",\"data\":{\"to\":\"string\",\"channel\":\"string\",\"verificationId\":\"string\",\"status\":\"string\"},\"transactionId\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 401, "status": "Unauthorized", "name": "Not authenticated", "schema": { "statusCode": { "type": "string", "description": "HTTP error code extension" }, "statusMessage": { "type": "string", "description": "More details and corrective actions related to the error which can be shown to a client." }, "SupportMessage": { "type": "string", "description": "Support Message" } }, "body": "{\"statusCode\":\"string\",\"statusMessage\":\"string\",\"SupportMessage\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 404, "status": "Not Found", "name": "Not found", "schema": { "statusCode": { "type": "string", "description": "HTTP error code extension" }, "statusMessage": { "type": "string", "description": "More details and corrective actions related to the error which can be shown to a client." }, "SupportMessage": { "type": "string", "description": "Support Message" } }, "body": "{\"statusCode\":\"string\",\"statusMessage\":\"string\",\"SupportMessage\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 407, "status": "Proxy Authentication Required", "name": "Proxy system not authenticated", "schema": { "statusCode": { "type": "string", "description": "HTTP error code extension" }, "statusMessage": { "type": "string", "description": "More details and corrective actions related to the error which can be shown to a client." }, "SupportMessage": { "type": "string", "description": "Support Message" } }, "body": "{\"statusCode\":\"string\",\"statusMessage\":\"string\",\"SupportMessage\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 500, "status": "Internal Server Error", "name": "Internal Server Error", "schema": { "timestamp": { "type": "string", "description": "Timestamp", "example": "2020-10-14T22:57:24.519+0000" }, "status": { "type": "string", "description": "HTTP error code extension", "example": "500" }, "error": { "type": "string", "description": "Support Message", "example": "Internal Server Error" }, "message": { "type": "string", "description": "Support Message", "example": "value" }, "path": { "type": "string", "description": "Path accessed", "example": "\/v1\/identity\/verification" } }, "body": "{\"timestamp\":\"string\",\"status\":\"string\",\"error\":\"string\",\"message\":\"string\",\"path\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] } ] } ] }