Orders

Get list of orders by SSN

Changed on

The endpoint returns a list of orders by an applicant SSN

post/v1/orders/lookup/

Request

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

Request body

ssnstring required

Response

countinteger required

Number of orders to return

nextstring nullable required

Url to the next page

previousstring nullable required

Url to the previous page

Example response

{
  "count": 100,
  "next": "https://prod.truv.com/v1/orders/lookup/?page=2",
  "previous": "https://prod.truv.com/v1/orders/lookup/?page=1",
  "results": [
    {
      "id": "39aa1486ccca4bc19cda071ffc1ba392",
      "products": [
        "income"
      ],
      "source": "floify",
      "order_number": "1534332",
      "client_name": "Unnamed Verifications Inc.",
      "first_name": "John",
      "last_name": "Doe",
      "user_id": "99dd17074ac94aa9ace2621d657c7610",
      "bridge_token": "e4100fccdae94691b4414c7306220c06",
      "share_url": "https://cdn.truv.com/employment.html?bridge_token=63b4af88facb40e48f517c1e8c7abdf4&order_group_id=39aa1486ccca4bc19cda071ffc1ba392",
      "created_at": "2021-04-21T21:45:14.418542Z",
      "updated_at": "2021-04-21T21:45:14.418542Z",
      "canceled_at": "2021-04-22T21:45:14.418542Z",
      "completed_at": "2021-04-22T21:45:14.418542Z",
      "expired_at": "2021-04-24T21:45:14.418542Z",
      "user_consent_at": "2021-04-21T21:45:14.418542Z",
      "initial_order": "f5dc0239e2094dbc90ab2edc1918a9df",
      "refresh_order": "9b96606355b94e8abff8ed8d75aa2027",
      "employers": [
        {
          "id": "ad9f14440d624ec3b0f66e81e44518c7",
          "product_type": "income",
          "status": "pending",
          "suborder_number": "133982343355",
          "created_at": "2021-04-21T22:12:59.346109Z",
          "bridge_token": "e4100fccdae94691b4414c7306220c06",
          "link_id": "e4100fccdae94691b4414c7306220c06",
          "access_token": "e4100fccdae94691b4414c7306220c06",
          "pdf_report": "https://cdn.truv.com/report.pdf",
          "data_source": "payroll",
          "provider": {
            "id": "truv_api",
            "name": "Sandbox Provider",
            "logo_url": "https://cdn.truv.com/providers/truv-blue.svg"
          },
          "start_date": "2019-08-24",
          "end_date": "2019-11-27",
          "company_name": "Facebook Demo",
          "company_address": {
            "street": "1 Hacker Way",
            "city": "Menlo Park",
            "state": "CA",
            "zip": "94025"
          },
          "company_domain": "facebook.com",
          "company_logo": "https://cdn.truv.com/company_logos/facebook.svg"
        }
      ],
      "insurance": {
        "id": "ad9f14440d624ec3b0f66e81e44518c7",
        "product_type": "insurance",
        "status": "pending",
        "suborder_number": "133982343355",
        "created_at": "2021-04-21T22:12:59.346109Z",
        "bridge_token": "e4100fccdae94691b4414c7306220c06",
        "link_id": "e4100fccdae94691b4414c7306220c06",
        "access_token": "e4100fccdae94691b4414c7306220c06",
        "pdf_report": "https://cdn.truv.com/report.pdf",
        "data_source": "insurance",
        "provider": {
          "id": "truv_api",
          "name": "Sandbox Provider",
          "logo_url": "https://cdn.truv.com/providers/truv-blue.svg"
        }
      },
      "manager": {
        "email": "john.doe@example.com",
        "name": "John Doe"
      },
      "financial_accounts": [
        {
          "id": "ad9f14440d624ec3b0f66e81e44518c7",
          "product_type": "transactions",
          "status": "pending",
          "suborder_number": "133982343355",
          "created_at": "2021-04-21T22:12:59.346109Z",
          "bridge_token": "e4100fccdae94691b4414c7306220c06",
          "link_id": "e4100fccdae94691b4414c7306220c06",
          "access_token": "e4100fccdae94691b4414c7306220c06",
          "pdf_report": "https://cdn.truv.com/report.pdf",
          "data_source": "financial_accounts",
          "provider": {
            "id": "truv_api",
            "name": "Sandbox Provider",
            "logo_url": "https://cdn.truv.com/providers/truv-blue.svg"
          },
          "last_task_status": "done",
          "accounts": [
            {
              "id": "24d7e80942ce4ad58a93f70ce4115f5c",
              "type": "CHECKING",
              "subtype": "MONEY_MARKET",
              "mask": "6789",
              "balance": "5000.00",
              "owners": [
                {
                  "full_name": "John Doe"
                }
              ]
            }
          ]
        }
      ],
      "loan": {
        "loan_number": "MUUT220700012",
        "application_number": "APP-2207-0001",
        "originator_name": "John Doe",
        "originator_email": "john@example.com",
        "loan_processor_name": "John Doe",
        "loan_processor_email": "john@doe.com",
        "external_id": "c505e0f1b4134fdc853fc87e7d2cc4a5"
      },
      "template_id": "9b96606355b94e8abff8ed8d75aa2027",
      "short_share_url": "https://truv.com/s/BIlEyh1A",
      "voie_report_id": "b19c454a98594b4084b71e3b62873d29",
      "voa_report_id": "b19c454a98594b4084b71e3b62873d29",
      "income_insights_report_id": "b19c454a98594b4084b71e3b62873d29",
      "aim_check_report_id": "FM-1234-39aa1486ccca4bc19cda071ffc1ba392",
      "notes": "To be processed by John Doe"
    }
  ]
}

Changes

    • info

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

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became optional for the status

    • info

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

    • info

      added subschema #1 subschema #2 to the // response property anyOf list for the response status