IRTP Authorization status

KB Tags associated with this article:
Use all tags
KB Tags
domorder
Body

Description

Get IRTP Authorization status for an action which is waiting for IRTP Authorization.

HTTP Method

POST

Example Test URL Request

https://test.httpapi.com/api/domains/irtp/verification/details.json?auth-userid=0&api-key=key&order-id=0

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Optional* Order-ID for which IRTP Authorization data is requested
domain-namme String Optional* Domain Name for which IRTP Authorization data is requested

*One of the above Parameters is Compulsory

Response

Returns a hash map containing the status of IRTP Authorization for a task

In case of any errors, a status key with value as ERROR alongwith an error message will be returned.

Note

This API call is only applicable for GTLDs and if Registrar is opted-in for IRTP.

  • Status (status)

  • Order ID (order-id)

  • Domain Name (domain-name)

  • IRTP Status (irtp-status)

    • Task Status (task-status)

      • task-status = PENDING|REVOKED|EXPIRED|FAILED|APPROVED|SUCCESS|REMOTE_FAILURE

    • Expiry (expiry)

    • Status of the Losing FOA (losing-foa-status)

      • foa-status (losing-foa-status/gaining-foa-status) = PENDING|APPROVED|DISAPPROVED

    • Status of the Gaining FOA (gaining-foa-status)

      • foa-status (losing-foa-status/gaining-foa-status) = PENDING|APPROVED|DISAPPROVED

    • Message (message)

      • message will only be mentioned in case the “task-status” is REVOKED/REMOTE_FAILURE