SET: Recipient details

Latest update: May 28, 2020

This service returns the details of the recipient informed by param.

Service

  • Method: GET
  • Service: /documents/api/v3/set/info/{setCode}/{recipientKey}
  • Content Type: URL param
  • Input params:
    • setCode (string)
    • recipientKey (string)
{setCode} : (string) (required) SET code returned by Viafirma
{recipientKey} : (string) (required) recipient.key
  • Response Content Type: application/type JSON in the Body of the response.
  • Response Status: 200 OK
  • Response Body:
{
  "code": "string",
  "status": "string",
  "messages": [
    {
      "code": "string",
      "title": "string",
      "link": "string",
      "status": "string",
      "recipientStatus": "string",
      "auditTrailPage": "string"
    }
  ]
}
  • Response Status: Other than 200 NOT OK
  • Response Body:
{
    "code": 9,
    "type": "String",
    "message": "string",
    "trace": "string"
}

results matching ""

    No results matching ""