MyGate

Partner Callback Event

Once the EAR is triggered, partner is informed of the request's transitions across different states via registered callback events. These callback events are sent out for all status transitions for a particular EAR to the URL shared by the partner.

Callback Event

{
"message": "String",
"delivery_id": "String",
"request_id": "String",
"status": "Enum",
"type": "Enum",
"status_code": "Integer",
"time": "Long",
"passcode": "Integer"
}

Status

ValueDescription
ACKNOWLEDGEDAll the sanity checks for the EAR have passed.
MATCHEAR is valid and matching MyGate user has been identified.
INITIATEDMyGate user approval process has been initiated.
APPROVEDEAR approved by MyGate user.
CHECKINPartner executive has entered the MyGate community for delivery.
CHECKOUTPartner executive has exited the MyGate community after delivery.
COMPLETEDEAR handling has been closed successfully.
NOMATCHUnable to find matching MyGate user for valid EAR.
FEATUREDISABLEDExpress Entry disabled for community or user.
EXPIREDEAR request is expired.
DECLINEDEAR declined by MyGate user.
INITIATIONERRORThere was a problem with processing the request.
DUPLICATENon unique delivery identifier send in EAR by partner.
CANCELLEDThe EAR request has been cancelled by partner.
Suggestions, contact, support and error reporting: [email protected]