QOqoreid

Get Workflow report by customer reference or request ID

Changed on

Get Workflow report by customer reference or request ID

get/v1/api/workflow/{workflowId}

Request

  • Base URL
    https://api.qoreid.com
  • URL
    https://api.qoreid.com/v1/api/workflow/{workflowId}
  • Auth
    OAuth 2

Path parameters

workflowIdstring required

the flow id for the request

Query parameters

requestIdstring

the request id

customerReferencestring

the customerReference for the request if you have one

Response

200

Example response

{
  "applicant": {
    "createdAt": "2023-05-12T12:50:48.000Z",
    "updatedAt": "2023-05-12T12:50:48.000Z",
    "id": 1,
    "organisationId": 1,
    "customerReference": "myreference-12123-ksds",
    "firstname": "John",
    "lastname": "Doe",
    "phone": "+2347011111111"
  },
  "flowRequestMetadata": {
    "id": 1,
    "flowId": 1,
    "reportType": "standard",
    "createdAt": "2023-05-12T12:50:49Z",
    "updatedAt": "2023-05-12T12:57:29Z",
    "status": "In_Progress",
    "countryCode": "NGA"
  },
  "verifications": [
    {
      "metadata": {
        "name": "Address",
        "stepNumber": 1,
        "serviceCode": "address",
        "status": "IN_PROGRESS",
        "submittedAt": "2023-05-12T12:57:29Z",
        "price": 100,
        "product": {
          "code": "verify_verifind_4d",
          "name": "Digital Address (4D)",
          "serviceType": "lastmile"
        }
      },
      "data": {
        "id": 1,
        "verificationTypeCode": "address",
        "organisationId": 1,
        "requestedAt": "2023-05-12T12:57:28.000Z",
        "requestSource": "api",
        "stateId": 12,
        "stateName": "Edo",
        "lgaId": 231,
        "lgaName": "Oredo",
        "countryName": "Nigeria",
        "isLive": true,
        "location": {
          "city": "Benin",
          "initialLatitude": 6.3,
          "initialLongitude": 5,
          "latitude": 6.3,
          "lgaName": "Oredo",
          "locationUrl": "https://maps.google.com/?q=6.3000000,5.000000",
          "longitude": 5,
          "stateName": "Edo",
          "street": "7 Okoro Street."
        },
        "customerReference": "myreference-12123-ksds",
        "applicant": {
          "createdAt": "2023-05-12T12:50:48.000Z",
          "updatedAt": "2023-05-12T12:50:48.000Z",
          "id": 1,
          "organisationId": 1,
          "customerReference": "myreference-12123-ksds",
          "firstname": "John",
          "lastname": "Doe",
          "phone": "+2347011111111"
        },
        "price": 100,
        "verifindReport": {
          "messages": [
            {
              "message": "User not at Address",
              "type": "negative"
            }
          ]
        },
        "status": {
          "status": "IN_PROGRESS",
          "subStatus": "IN PROGRESS",
          "state": "IN_PROGRESS"
        }
      }
    }
  ]
}

Changes