The TFNRegistry™ API sends this Unsolicited Approval Status (UNS-APP) Message to Resp Orgs that have this message configured in the General Notification & Approval Setup (GNA) page within the TFNRegistry by the Carrier. The Resp Org will need to work with their Carrier to register for this message on a specific CIC. For more information regarding the GNA page, please refer to the TFNRegistry User Guide. The Carrier can complete the configuration by entering the Unsolicited Notification (Domain Name and Port) on the GNA page. Please Note: All Asynchronous Callback URLs can only be utilized via Port 443 with SSL/TLS encryption. The messages that are sent from the Production and Sandbox TFNRegistry are sent over the public internet. For more information on how to register for Unsolicited Messages, please click here.
The approval status message is sent to all affected carriers at the download time whenever any affected carrier denies or does not respond to an approval request for a Customer Record (regular Customer Record or Pointer Record) or a Template Record.
End Point URL
/v3/ext/uns/app
JSON Format
JSON message structure for UNS-APP message.
{
“tfNum”: “”,
“tmplName”: “”,
“effDtTm”: “”,
“RespOrgId”: “”,
“cicCode”:””,
“reason": “”
}
Parameter Descriptions
Table 6: UNS-APP Parameter Descriptions
|
Table 6: UNS-APP Parameter Descriptions |
|
|
Parameter |
Description |
|
tfNum |
Populated if the Customer Record is a regular Customer Record or a Pointer Record.
xxx-nxx-xxxx, where:
xxx = (NPA), 800 and other open 8xx codes nxx = (NXX) digits xxxx= (LINE) digits |
|
tmplName |
A unique template name which identifies the template, this contains the routing information for the Pointer Record. 15-character identifier starting with an asterisk (*). |
|
effDtTm |
The standard format for date and time is: YYYY-MM-DDTHH:MMZ Effective Date and Time of the Customer Record that is sent in the notification. Please refer to the API Overview document for more information. |
|
RespOrgId |
It is the Resp Org ID of the user. Alphanumeric (5). |
|
cicCode |
Carrier Identification Code (CIC) Code: Identifies the affected carrier to whom this message applies. Sent only in case the message is not sent to the controlling (current, old) Resp Org. Alphanumeric (6). |
|
reason |
Reason for Approval or Denial:
|