TRtruv
Orders

Retrieve self-certification results for an order

Changed on

The endpoint returns self-certification results for employments, accounts, and education enrollments that have been reviewed and certified by the user.

get/v1/orders/{id}/certifications/

Request

  • Base URL
    https://prod.truv.com
  • URL
    https://prod.truv.com/v1/orders/{id}/certifications/
  • Auth
    API key in header X-Access-Client-Id and API key in header X-Access-Secret

Response

Self-certification results

Example response

{
  "results": [
    {
      "decision": "representative",
      "employment": {
        "id": "24d7e80942ce4ad58a93f70ce4115f5c",
        "start_date": "2018-01-01",
        "pay_rate": "25.50",
        "pay_date": "2023-12-15",
        "company": {
          "name": "Facebook"
        }
      }
    },
    {
      "decision": "not_representative",
      "rejection_reason": "incorrect_amount",
      "rejection_comment": "Balance is outdated",
      "account": {
        "id": "bc917458a3da4b2c8cc8282aa1707aaa",
        "type": "CHECKING",
        "mask": "1234",
        "routing_number": "021000021",
        "balance": "1500.25",
        "owners": [
          {
            "full_name": "John Doe"
          }
        ]
      }
    },
    {
      "decision": "not_representative",
      "rejection_reason": "incorrect_enrollment_type",
      "rejection_comment": "Enrollment was full time that term",
      "education_enrollment": {
        "school_name": "Arizona State University",
        "enrollment_type": "half_time",
        "enrolled_since": "2023-08-21",
        "status": "active"
      }
    }
  ]
}

Changes

  • 07068044e23dRevision changes
    • breaking

      added subschema #3 to the / response property oneOf list for the response status

    • breaking

      the // response's property type changed from string to no type for status

    • info

      added the optional property // to the response with the status

    • info

      added to the // response property anyOf list for the response status

    • info

      removed the duplicate_entry enum value from the // response property for the response status

    • info

      removed the employment_no_longer_active enum value from the // response property for the response status

    • info

      removed the incorrect_amount enum value from the // response property for the response status

    • info

      removed the other enum value from the // response property for the response status

    • info

      removed the outdated_information enum value from the // response property for the response status

    • info

      removed the undefined enum value from the // response property for the response status

  • c2d59bd02388Revision changes
    • warning

      added the new not_applicable enum value to the // response property for the response status

    • warning

      added the new pending enum value to the // response property for the response status