{"items":[{"type":"link","label":"Checkr Tenant API","link":"/v1","routeSlug":"/v1","content":{"contentType":"overview","meta":{"name":"Checkr Tenant API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"v1.json","url":"/_bundle/v1.json?download"},{"kind":"download","label":"v1.yaml","url":"/_bundle/v1.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"URL","titleTranslationKey":"info.contact.url","label":"https://tenant.checkr.com","url":"https://tenant.checkr.com"},{"kind":"email","title":"Tenant Engineering","email":"hello-tenant@checkr.com","label":"hello-tenant@checkr.com","withCopyButton":true,"copyContent":"hello-tenant@checkr.com"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://tenant.checkr.com/api","description":"Checkr Tenant API"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Checkr Tenant API (1.0)","showPageActions":true},{"nodeType":"markdoc","content":"The Tenant Monolith API is a RESTful service that powers tenant screening\nworkflows at Checkr. It uses resource-oriented URLs, supports HTTPS for\nauthentication and requests, and returns JSON responses.\n"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Checkr Tenant API lets property managers and landlords order tenant"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"screenings, manage rental properties, and retrieve screening reports"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"programmatically. It is organized around four core resources:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Properties"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — rental addresses you screen applicants for."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applicants"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — people being screened."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — a screening request placed for an applicant against a property."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reports"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the results returned by an order, broken down by check type."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reports are produced asynchronously. You can either listen for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"report.*"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhooks"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or poll "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /orders/{id}/report"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". All resources are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"isolated per environment via test and live API keys — see the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/testing"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Testing guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for how mode isolation works and which scenarios"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"are available against test keys."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"New to the API? Start with the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Getting Started guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"end-to-end walkthrough, including authorization, billing setup, and your first"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order."},"children":[]}]}]}]}],"sectionId":"/v1"}],"sectionId":"/v1"}]}]}},{"type":"separator","label":"Resources","content":null},{"type":"group","label":"Orders","link":"/v1/orders","routeSlug":"/v1/orders","items":[{"label":"List orders","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/orders/get-orders","routeSlug":"/v1/orders/get-orders","metadata":{"seo":{"title":"List orders","description":"List the orders owned by your organization, newest first. The responseis paginated — see next_href / previous_href for walking throughpages. Live-mode keys see only live-mode orders; test-mode keys seeonly test-mode orders."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-orders","name":"List orders","isWebhook":false,"pointer":"/paths/~1orders/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List orders","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List the orders owned by your organization, newest first. The response"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is paginated — see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_href"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"previous_href"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for walking through"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pages. Live-mode keys see only live-mode orders; test-mode keys see"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"only test-mode orders."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer-token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key issued to your organization. Send it as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_16","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Opaque pagination token. Omit on the first request, then follow the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_href"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"previous_href"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" URLs in the response — those URLs already"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"have the correct cursor encoded. Cursors from one endpoint are not valid"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"on another. An invalid cursor returns 422."},"children":[]}]}]}]},{"name":"per_page","in":"query","schemaId":"schema_17","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Page size. Defaults to 25; the maximum is 100. The chosen size is preserved"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_href"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"previous_href"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", so you only need to set it on the first"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"request of a walk."},"children":[]}]}]}]},{"name":"include","in":"query","schemaId":"schema_18","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma-separated list of related objects to embed in the response. Supported values:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"property"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"applicant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". By default only the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"property_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"applicant_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are returned."},"children":[]}]}]}]}],"pointer":"/paths/~1orders/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Checkr-Tenant-Version","in":"header","schemaId":"schema_19","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CalVer-dated API version to pin behavior to (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2026-04-29"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). When omitted,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the request is served by the newest supported version. Unknown values return 422."},"children":[]}]}]}]}],"pointer":"/paths/~1orders/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/orders","servers":[{"url":"https://tenant.checkr.com/api","description":"Checkr Tenant API"}],"parameters":{"path":[],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_16"},{"name":"per_page","in":"query","required":false,"schemaId":"schema_17"},{"name":"include","in":"query","required":false,"example":"property,applicant","schemaId":"schema_18"}],"querystring":[],"header":[{"name":"Checkr-Tenant-Version","in":"header","required":false,"schemaId":"schema_19"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer-token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","422"],"pointer":"/orders","href":"orders/get-orders","openApiOperationId":"get-orders","summary":"List orders"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://tenant.checkr.com/api","description":"Checkr Tenant API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/order-list"}},"schemaId":"components/schemas/order-list"},{"code":"401","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}},"schemaId":"components/schemas/errors"},{"code":"403","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}},"schemaId":"components/schemas/errors"},{"code":"422","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}},"schemaId":"components/schemas/errors"}],"pointer":"/paths/~1orders/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/order-list","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/order-list"}}},{"code":"401","schemaId":"components/schemas/errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}}},{"code":"403","schemaId":"components/schemas/errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}}},{"code":"422","schemaId":"components/schemas/errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/get-orders"}],"panels":[]}]},"httpPath":"/orders"},{"label":"Create order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/orders/post-orders","routeSlug":"/v1/orders/post-orders","metadata":{"seo":{"title":"Create order","description":"Create a new screening order for an applicant against a property. Theproperty and the applicant can each be supplied either inline (address/ identity fields) — in which case a new record is created — or by id(property_id / applicant_id) to reuse an existing record. Provideexactly one form per side."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"post-orders","name":"Create order","isWebhook":false,"pointer":"/paths/~1orders/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a new screening order for an applicant against a property. The"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"property and the applicant can each be supplied either inline (address"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/ identity fields) — in which case a new record is created — or by id"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"property_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"applicant_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") to reuse an existing record. Provide"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"exactly one form per side."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer-token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key issued to your organization. Send it as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_18","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma-separated list of related objects to embed in the response. Supported values:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"property"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"applicant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". By default only the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"property_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"applicant_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are returned."},"children":[]}]}]}]}],"pointer":"/paths/~1orders/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_20","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique, client-generated string (1–255 characters; a UUIDv4 is recommended)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"that identifies a single logical request. Reusing the same key replays the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"original response. Transient errors (5xx) are not replayed — retrying with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the same key will re-execute the request. Generate a fresh key per logical"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"request; only reuse it when retrying the same request."},"children":[]}]}]}],"required":true},{"name":"Checkr-Tenant-Version","in":"header","schemaId":"schema_19","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CalVer-dated API version to pin behavior to (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2026-04-29"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). When omitted,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the request is served by the newest supported version. Unknown values return 422."},"children":[]}]}]}]}],"pointer":"/paths/~1orders/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_21"}},"schemaId":"schema_21","pointer":"/paths/~1orders/post/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request body for creating a new order. Each side of the order — the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"property and the applicant — can be supplied either inline (the address"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or identity fields) or by id (a previously created "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pr_…"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ap_…"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide exactly one form per side; sending both, or neither, returns a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"validation error."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/orders","servers":[{"url":"https://tenant.checkr.com/api","description":"Checkr Tenant API"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","required":false,"example":"property,applicant","schemaId":"schema_18"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":true,"example":"8e1bce8f-2a5e-4f7e-9f61-7e1f3e6e0c7b","schemaId":"schema_20"},{"name":"Checkr-Tenant-Version","in":"header","required":false,"schemaId":"schema_19"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer-token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_21"}},"responseCodes":["201","401","402","403","404","422"],"pointer":"/orders","href":"orders/post-orders","openApiOperationId":"post-orders","summary":"Create order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://tenant.checkr.com/api","description":"Checkr Tenant API"}],"schemaId":"schema_21","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_21"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/order"}},"schemaId":"components/schemas/order"},{"code":"401","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}},"schemaId":"components/schemas/errors"},{"code":"402","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}},"schemaId":"components/schemas/errors"},{"code":"403","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}},"schemaId":"components/schemas/errors"},{"code":"404","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}},"schemaId":"components/schemas/errors"},{"code":"422","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}},"schemaId":"components/schemas/errors"}],"pointer":"/paths/~1orders/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/order","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/order"}}},{"code":"401","schemaId":"components/schemas/errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}}},{"code":"402","schemaId":"components/schemas/errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}}},{"code":"403","schemaId":"components/schemas/errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}}},{"code":"404","schemaId":"components/schemas/errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}}},{"code":"422","schemaId":"components/schemas/errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/post-orders"}],"panels":[]}]},"httpPath":"/orders"},{"label":"Get order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/orders/get-order","routeSlug":"/v1/orders/get-order","metadata":{"seo":{"title":"Get order","description":"Retrieve an order by its id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-order","name":"Get order","isWebhook":false,"pointer":"/paths/~1orders~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve an order by its id."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer-token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key issued to your organization. Send it as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_16","description":"Id of the order.","required":true}],"pointer":"/paths/~1orders~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_18","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma-separated list of related objects to embed in the response. Supported values:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"property"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"applicant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". By default only the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"property_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"applicant_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are returned."},"children":[]}]}]}]}],"pointer":"/paths/~1orders~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Checkr-Tenant-Version","in":"header","schemaId":"schema_19","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CalVer-dated API version to pin behavior to (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2026-04-29"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). When omitted,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the request is served by the newest supported version. Unknown values return 422."},"children":[]}]}]}]}],"pointer":"/paths/~1orders~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/orders/{id}","servers":[{"url":"https://tenant.checkr.com/api","description":"Checkr Tenant API"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_16"}],"query":[{"name":"include","in":"query","required":false,"example":"property,applicant","schemaId":"schema_18"}],"querystring":[],"header":[{"name":"Checkr-Tenant-Version","in":"header","required":false,"schemaId":"schema_19"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer-token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404","422"],"pointer":"/orders/{id}","href":"orders/get-order","openApiOperationId":"get-order","summary":"Get order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://tenant.checkr.com/api","description":"Checkr Tenant API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/order"}},"schemaId":"components/schemas/order"},{"code":"401","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}},"schemaId":"components/schemas/errors"},{"code":"403","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}},"schemaId":"components/schemas/errors"},{"code":"404","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}},"schemaId":"components/schemas/errors"},{"code":"422","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}},"schemaId":"components/schemas/errors"}],"pointer":"/paths/~1orders~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/order","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/order"}}},{"code":"401","schemaId":"components/schemas/errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}}},{"code":"403","schemaId":"components/schemas/errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}}},{"code":"404","schemaId":"components/schemas/errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}}},{"code":"422","schemaId":"components/schemas/errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/get-order"}],"panels":[]}]},"httpPath":"/orders/{id}"}],"content":{"contentType":"group","meta":{"name":"Orders"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Orders","showPageActions":true},{"nodeType":"markdoc","content":"Screening orders placed for an applicant against a property."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/orders","summary":"List orders","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/get-orders","deprecated":false},{"title":"/orders","summary":"Create order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/post-orders","deprecated":false},{"title":"/orders/{id}","summary":"Get order","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/get-order","deprecated":false}]}]}]}]}},{"type":"group","label":"Reports","link":"/v1/reports","routeSlug":"/v1/reports","items":[{"label":"Get report for order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/reports/get-order-report","routeSlug":"/v1/reports/get-order-report","metadata":{"seo":{"title":"Get report for order","description":"Retrieve the report associated with an order. Returns 404 if theorder has not yet produced a report — typically because it is stillin waiting_for_applicant or pending status."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-order-report","name":"Get report for order","isWebhook":false,"pointer":"/paths/~1orders~1{id}~1report/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get report for order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve the report associated with an order. Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order has not yet produced a report — typically because it is still"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"waiting_for_applicant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer-token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key issued to your organization. Send it as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_16","description":"Id of the order.","required":true}],"pointer":"/paths/~1orders~1{id}~1report/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Checkr-Tenant-Version","in":"header","schemaId":"schema_19","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CalVer-dated API version to pin behavior to (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2026-04-29"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). When omitted,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the request is served by the newest supported version. Unknown values return 422."},"children":[]}]}]}]}],"pointer":"/paths/~1orders~1{id}~1report/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/orders/{id}/report","servers":[{"url":"https://tenant.checkr.com/api","description":"Checkr Tenant API"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_16"}],"query":[],"querystring":[],"header":[{"name":"Checkr-Tenant-Version","in":"header","required":false,"schemaId":"schema_19"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer-token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404","422"],"pointer":"/orders/{id}/report","href":"reports/get-order-report","openApiOperationId":"get-order-report","summary":"Get report for order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://tenant.checkr.com/api","description":"Checkr Tenant API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/report"}},"schemaId":"components/schemas/report"},{"code":"401","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}},"schemaId":"components/schemas/errors"},{"code":"403","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}},"schemaId":"components/schemas/errors"},{"code":"404","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}},"schemaId":"components/schemas/errors"},{"code":"422","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}},"schemaId":"components/schemas/errors"}],"pointer":"/paths/~1orders~1{id}~1report/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/report","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/report"}}},{"code":"401","schemaId":"components/schemas/errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}}},{"code":"403","schemaId":"components/schemas/errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}}},{"code":"404","schemaId":"components/schemas/errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}}},{"code":"422","schemaId":"components/schemas/errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reports/get-order-report"}],"panels":[]}]},"httpPath":"/orders/{id}/report"},{"label":"Get report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/reports/get-report","routeSlug":"/v1/reports/get-report","metadata":{"seo":{"title":"Get report","description":"Retrieve a report by its id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-report","name":"Get report","isWebhook":false,"pointer":"/paths/~1reports~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a report by its id."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer-token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key issued to your organization. Send it as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_16","description":"Id of the report.","required":true}],"pointer":"/paths/~1reports~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Checkr-Tenant-Version","in":"header","schemaId":"schema_19","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CalVer-dated API version to pin behavior to (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2026-04-29"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). When omitted,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the request is served by the newest supported version. Unknown values return 422."},"children":[]}]}]}]}],"pointer":"/paths/~1reports~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/reports/{id}","servers":[{"url":"https://tenant.checkr.com/api","description":"Checkr Tenant API"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_16"}],"query":[],"querystring":[],"header":[{"name":"Checkr-Tenant-Version","in":"header","required":false,"schemaId":"schema_19"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer-token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404","422"],"pointer":"/reports/{id}","href":"reports/get-report","openApiOperationId":"get-report","summary":"Get report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://tenant.checkr.com/api","description":"Checkr Tenant API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/report"}},"schemaId":"components/schemas/report"},{"code":"401","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}},"schemaId":"components/schemas/errors"},{"code":"403","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}},"schemaId":"components/schemas/errors"},{"code":"404","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}},"schemaId":"components/schemas/errors"},{"code":"422","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}},"schemaId":"components/schemas/errors"}],"pointer":"/paths/~1reports~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/report","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/report"}}},{"code":"401","schemaId":"components/schemas/errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}}},{"code":"403","schemaId":"components/schemas/errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}}},{"code":"404","schemaId":"components/schemas/errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}}},{"code":"422","schemaId":"components/schemas/errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reports/get-report"}],"panels":[]}]},"httpPath":"/reports/{id}"},{"label":"Download report PDF","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/reports/get-report-pdf","routeSlug":"/v1/reports/get-report-pdf","metadata":{"seo":{"title":"Download report PDF","description":"Download the report as a PDF file. The PDF is generated and returnedsynchronously in a single response — the bytes (application/pdf)come back on the same call, with no polling or callback. Generationcan take several seconds when a fresh render is required, soconfigure your HTTP client's read timeout to at least 60 secondsfor this endpoint to avoid prematurely aborting in-progress renders."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-report-pdf","name":"Download report PDF","isWebhook":false,"pointer":"/paths/~1reports~1{id}~1pdf/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download report PDF","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Download the report as a PDF file. The PDF is generated and returned"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"synchronously in a single response — the bytes ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/pdf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"come back on the same call, with no polling or callback. Generation"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"can take several seconds when a fresh render is required, so"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"configure your HTTP client's "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"read timeout to at least 60 seconds"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for this endpoint to avoid prematurely aborting in-progress renders."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Handling failures."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Rendering can fail transiently for various reasons."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is suggested that if you encounter an error, you should retry the request,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"within a reasonable policy."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer-token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key issued to your organization. Send it as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_16","description":"Id of the report.","required":true}],"pointer":"/paths/~1reports~1{id}~1pdf/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Checkr-Tenant-Version","in":"header","schemaId":"schema_19","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CalVer-dated API version to pin behavior to (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2026-04-29"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). When omitted,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the request is served by the newest supported version. Unknown values return 422."},"children":[]}]}]}]}],"pointer":"/paths/~1reports~1{id}~1pdf/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/reports/{id}/pdf","servers":[{"url":"https://tenant.checkr.com/api","description":"Checkr Tenant API"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_16"}],"query":[],"querystring":[],"header":[{"name":"Checkr-Tenant-Version","in":"header","required":false,"schemaId":"schema_19"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer-token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404","500"],"pointer":"/reports/{id}/pdf","href":"reports/get-report-pdf","openApiOperationId":"get-report-pdf","summary":"Download report PDF"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://tenant.checkr.com/api","description":"Checkr Tenant API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The PDF file.","mediaType":"application/pdf","mediaTypes":["application/pdf"],"mediaTypeContent":{"application/pdf":{"schemaId":"schema_22"}},"schemaId":"schema_22","headers":{"Content-Disposition":{"description":"Attachment disposition with the report's canonical filename.","schema":{"type":"string"}},"Cache-Control":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"private, no-store"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the PDF contains PII and must not"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"be cached by intermediaries or the client."},"children":[]}]}]}],"schema":{"type":"string"}}},"headerSchemaId":"schema_23"},{"code":"401","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}},"schemaId":"components/schemas/errors"},{"code":"403","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}},"schemaId":"components/schemas/errors"},{"code":"404","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}},"schemaId":"components/schemas/errors"},{"code":"500","description":"Generation failed transiently for various reasons. If you encounter an error, you should retry the request,\nwithin a reasonable policy.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}},"schemaId":"components/schemas/errors"}],"pointer":"/paths/~1reports~1{id}~1pdf/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_22","mediaTypes":["application/pdf"],"mediaTypeContent":{"application/pdf":{"schemaId":"schema_22"}}},{"code":"401","schemaId":"components/schemas/errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}}},{"code":"403","schemaId":"components/schemas/errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}}},{"code":"404","schemaId":"components/schemas/errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}}},{"code":"500","schemaId":"components/schemas/errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reports/get-report-pdf"}],"panels":[]}]},"httpPath":"/reports/{id}/pdf"},{"label":"Download all report documents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/reports/get-report-documents-zip","routeSlug":"/v1/reports/get-report-documents-zip","metadata":{"seo":{"title":"Download all report documents","description":"Download every document collected for the report as a single ZIParchive. The bytes (application/zip) come back on the same call."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-report-documents-zip","name":"Download all report documents","isWebhook":false,"pointer":"/paths/~1reports~1{id}~1documents~1zip/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download all report documents","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Download every document collected for the report as a single ZIP"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"archive. The bytes ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/zip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") come back on the same call."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the report has no documents."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Entries are namespaced by the kind of document:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"income_documents/"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the proof-of-income documents the applicant"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"uploaded, the same set listed in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"income_verification.documents"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present only when the order was placed with document-based income"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"verification."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identity_verification/"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the document images captured during the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"applicant's identity verification session. Present only when the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order included the identity verification product."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer-token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key issued to your organization. Send it as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_16","description":"Id of the report.","required":true}],"pointer":"/paths/~1reports~1{id}~1documents~1zip/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Checkr-Tenant-Version","in":"header","schemaId":"schema_19","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CalVer-dated API version to pin behavior to (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2026-04-29"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). When omitted,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the request is served by the newest supported version. Unknown values return 422."},"children":[]}]}]}]}],"pointer":"/paths/~1reports~1{id}~1documents~1zip/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/reports/{id}/documents/zip","servers":[{"url":"https://tenant.checkr.com/api","description":"Checkr Tenant API"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_16"}],"query":[],"querystring":[],"header":[{"name":"Checkr-Tenant-Version","in":"header","required":false,"schemaId":"schema_19"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer-token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/reports/{id}/documents/zip","href":"reports/get-report-documents-zip","openApiOperationId":"get-report-documents-zip","summary":"Download all report documents"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://tenant.checkr.com/api","description":"Checkr Tenant API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ZIP archive. Entries keep the filename the document was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"uploaded under; a name that would collide within a folder gets a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":" (n)"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" suffix before its extension."},"children":[]}]}]}],"mediaType":"application/zip","mediaTypes":["application/zip"],"mediaTypeContent":{"application/zip":{"schemaId":"schema_22"}},"schemaId":"schema_22","headers":{"Content-Disposition":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attachment disposition with a filename of"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"documents-<report_id>.zip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"schema":{"type":"string"}},"Cache-Control":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"private, no-store"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the archive contains PII and must"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not be cached by intermediaries or the client."},"children":[]}]}]}],"schema":{"type":"string"}}},"headerSchemaId":"schema_24"},{"code":"401","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}},"schemaId":"components/schemas/errors"},{"code":"403","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}},"schemaId":"components/schemas/errors"},{"code":"404","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}},"schemaId":"components/schemas/errors"}],"pointer":"/paths/~1reports~1{id}~1documents~1zip/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_22","mediaTypes":["application/zip"],"mediaTypeContent":{"application/zip":{"schemaId":"schema_22"}}},{"code":"401","schemaId":"components/schemas/errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}}},{"code":"403","schemaId":"components/schemas/errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}}},{"code":"404","schemaId":"components/schemas/errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reports/get-report-documents-zip"}],"panels":[]}]},"httpPath":"/reports/{id}/documents/zip"},{"label":"Download a report document","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/reports/get-report-document","routeSlug":"/v1/reports/get-report-document","metadata":{"seo":{"title":"Download a report document","description":"Download a single document collected for the report, in the format itwas uploaded — read Content-Type rather than assuming PDF. Returns404 if the document does not exist on this report, or is of a kindnot retrievable for its order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-report-document","name":"Download a report document","isWebhook":false,"pointer":"/paths/~1reports~1{id}~1documents~1{document_id}~1download/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download a report document","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Download a single document collected for the report, in the format it"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"was uploaded — read "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" rather than assuming PDF. Returns"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the document does not exist on this report, or is of a kind"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not retrievable for its order."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer-token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key issued to your organization. Send it as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_16","description":"Id of the report.","required":true},{"name":"document_id","in":"path","schemaId":"schema_16","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Id of the document, as it appears in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"income_verification.documents[].id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":"inc_K9dM2pXqR4vN8tLZbWyHJa"}],"pointer":"/paths/~1reports~1{id}~1documents~1{document_id}~1download/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Checkr-Tenant-Version","in":"header","schemaId":"schema_19","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CalVer-dated API version to pin behavior to (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2026-04-29"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). When omitted,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the request is served by the newest supported version. Unknown values return 422."},"children":[]}]}]}]}],"pointer":"/paths/~1reports~1{id}~1documents~1{document_id}~1download/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/reports/{id}/documents/{document_id}/download","servers":[{"url":"https://tenant.checkr.com/api","description":"Checkr Tenant API"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_16"},{"name":"document_id","in":"path","required":true,"example":"inc_K9dM2pXqR4vN8tLZbWyHJa","schemaId":"schema_16"}],"query":[],"querystring":[],"header":[{"name":"Checkr-Tenant-Version","in":"header","required":false,"schemaId":"schema_19"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer-token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/reports/{id}/documents/{document_id}/download","href":"reports/get-report-document","openApiOperationId":"get-report-document","summary":"Download a report document"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://tenant.checkr.com/api","description":"Checkr Tenant API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The document file, in whatever format it was uploaded.","mediaType":"application/pdf","mediaTypes":["application/pdf","image/jpeg","image/png"],"mediaTypeContent":{"application/pdf":{"schemaId":"schema_22"},"image/jpeg":{"schemaId":"schema_22"},"image/png":{"schemaId":"schema_22"}},"schemaId":"schema_22","headers":{"Content-Disposition":{"description":"Attachment disposition with the filename the applicant\nuploaded the document under.\n","schema":{"type":"string"}},"Cache-Control":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"private, no-store"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the document contains PII and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"must not be cached by intermediaries or the client."},"children":[]}]}]}],"schema":{"type":"string"}}},"headerSchemaId":"schema_25"},{"code":"401","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}},"schemaId":"components/schemas/errors"},{"code":"403","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}},"schemaId":"components/schemas/errors"},{"code":"404","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}},"schemaId":"components/schemas/errors"}],"pointer":"/paths/~1reports~1{id}~1documents~1{document_id}~1download/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_22","mediaTypes":["application/pdf","image/jpeg","image/png"],"mediaTypeContent":{"application/pdf":{"schemaId":"schema_22"},"image/jpeg":{"schemaId":"schema_22"},"image/png":{"schemaId":"schema_22"}}},{"code":"401","schemaId":"components/schemas/errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}}},{"code":"403","schemaId":"components/schemas/errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}}},{"code":"404","schemaId":"components/schemas/errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reports/get-report-document"}],"panels":[]}]},"httpPath":"/reports/{id}/documents/{document_id}/download"}],"content":{"contentType":"group","meta":{"name":"Reports"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reports","showPageActions":true},{"nodeType":"markdoc","content":"Screening results produced for an order, broken down by check type."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/orders/{id}/report","summary":"Get report for order","prefix":{"name":"get","color":"get"},"badges":[],"link":"/reports/get-order-report","deprecated":false},{"title":"/reports/{id}","summary":"Get report","prefix":{"name":"get","color":"get"},"badges":[],"link":"/reports/get-report","deprecated":false},{"title":"/reports/{id}/pdf","summary":"Download report PDF","prefix":{"name":"get","color":"get"},"badges":[],"link":"/reports/get-report-pdf","deprecated":false},{"title":"/reports/{id}/documents/zip","summary":"Download all report documents","prefix":{"name":"get","color":"get"},"badges":[],"link":"/reports/get-report-documents-zip","deprecated":false},{"title":"/reports/{id}/documents/{document_id}/download","summary":"Download a report document","prefix":{"name":"get","color":"get"},"badges":[],"link":"/reports/get-report-document","deprecated":false}]}]}]}]}},{"type":"group","label":"Properties","link":"/v1/properties","routeSlug":"/v1/properties","items":[{"label":"List properties","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/properties/get-properties","routeSlug":"/v1/properties/get-properties","metadata":{"seo":{"title":"List properties","description":"List the properties owned by your organization, newest first. Theresponse is paginated — see next_href / previous_href for walkingthrough pages."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-properties","name":"List properties","isWebhook":false,"pointer":"/paths/~1properties/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List properties","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List the properties owned by your organization, newest first. The"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"response is paginated — see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_href"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"previous_href"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for walking"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"through pages."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer-token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key issued to your organization. Send it as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_16","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Opaque pagination token. Omit on the first request, then follow the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_href"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"previous_href"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" URLs in the response — those URLs already"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"have the correct cursor encoded. Cursors from one endpoint are not valid"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"on another. An invalid cursor returns 422."},"children":[]}]}]}]},{"name":"per_page","in":"query","schemaId":"schema_17","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Page size. Defaults to 25; the maximum is 100. The chosen size is preserved"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_href"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"previous_href"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", so you only need to set it on the first"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"request of a walk."},"children":[]}]}]}]}],"pointer":"/paths/~1properties/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Checkr-Tenant-Version","in":"header","schemaId":"schema_19","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CalVer-dated API version to pin behavior to (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2026-04-29"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). When omitted,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the request is served by the newest supported version. Unknown values return 422."},"children":[]}]}]}]}],"pointer":"/paths/~1properties/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/properties","servers":[{"url":"https://tenant.checkr.com/api","description":"Checkr Tenant API"}],"parameters":{"path":[],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_16"},{"name":"per_page","in":"query","required":false,"schemaId":"schema_17"}],"querystring":[],"header":[{"name":"Checkr-Tenant-Version","in":"header","required":false,"schemaId":"schema_19"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer-token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","422"],"pointer":"/properties","href":"properties/get-properties","openApiOperationId":"get-properties","summary":"List properties"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://tenant.checkr.com/api","description":"Checkr Tenant API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/property-list"}},"schemaId":"components/schemas/property-list"},{"code":"401","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}},"schemaId":"components/schemas/errors"},{"code":"403","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}},"schemaId":"components/schemas/errors"},{"code":"422","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}},"schemaId":"components/schemas/errors"}],"pointer":"/paths/~1properties/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/property-list","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/property-list"}}},{"code":"401","schemaId":"components/schemas/errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}}},{"code":"403","schemaId":"components/schemas/errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}}},{"code":"422","schemaId":"components/schemas/errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/properties/get-properties"}],"panels":[]}]},"httpPath":"/properties"},{"label":"Create property","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/properties/post-properties","routeSlug":"/v1/properties/post-properties","metadata":{"seo":{"title":"Create property","description":"Create a new property record from a mailing address. Properties createddirectly via this endpoint can later be referenced by property_idwhen creating an order, instead of supplying the address inline again."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"post-properties","name":"Create property","isWebhook":false,"pointer":"/paths/~1properties/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create property","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a new property record from a mailing address. Properties created"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"directly via this endpoint can later be referenced by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"property_id"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"when creating an order, instead of supplying the address inline again."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"properties/post-properties/request/address-based-deduplication","deepLinkHash":"/properties/post-properties#properties/post-properties/request/address-based-deduplication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Address-based deduplication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Properties are deduplicated by address within your organization. If"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you submit an address that already matches an existing property, that"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"existing property is returned and no new record is created — making"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this endpoint safely idempotent for repeated submissions of the same"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"address."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Address matching is case- and whitespace-insensitive across "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"street"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"city"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value matches with or without a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"leading "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"#"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"4B\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"#4B\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are equivalent). A 5-digit "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"zipcode"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"matches its ZIP+4 form ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"94111"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is equivalent to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"94111-1234"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Abbreviations are treated literally — "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"123 Main St\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"123 Main Street\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are different addresses."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response status indicates which path was taken:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"201 Created"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — a new property was created"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200 OK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the address matched an existing property; that record is returned"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header always points to the canonical property URL."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer-token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key issued to your organization. Send it as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Checkr-Tenant-Version","in":"header","schemaId":"schema_19","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CalVer-dated API version to pin behavior to (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2026-04-29"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). When omitted,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the request is served by the newest supported version. Unknown values return 422."},"children":[]}]}]}]}],"pointer":"/paths/~1properties/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_26"}},"schemaId":"schema_26","pointer":"/paths/~1properties/post/requestBody","description":"The request body for creating a new property."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/properties","servers":[{"url":"https://tenant.checkr.com/api","description":"Checkr Tenant API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Checkr-Tenant-Version","in":"header","required":false,"schemaId":"schema_19"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer-token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_26"}},"responseCodes":["200","201","401","403","422"],"pointer":"/properties","href":"properties/post-properties","openApiOperationId":"post-properties","summary":"Create property"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://tenant.checkr.com/api","description":"Checkr Tenant API"}],"schemaId":"schema_26","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_26"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OK — the address matched an existing property in your organization; the existing record is returned and no new property was created."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/property"}},"schemaId":"components/schemas/property","headers":{"Location":{"schema":{"type":"string"},"description":"URL of the existing property."}},"headerSchemaId":"schema_27"},{"code":"201","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Created — a new property was created."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/property"}},"schemaId":"components/schemas/property","headers":{"Location":{"schema":{"type":"string"},"description":"URL of the newly created property."}},"headerSchemaId":"schema_28"},{"code":"401","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}},"schemaId":"components/schemas/errors"},{"code":"403","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}},"schemaId":"components/schemas/errors"},{"code":"422","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}},"schemaId":"components/schemas/errors"}],"pointer":"/paths/~1properties/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/property","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/property"}}},{"code":"201","schemaId":"components/schemas/property","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/property"}}},{"code":"401","schemaId":"components/schemas/errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}}},{"code":"403","schemaId":"components/schemas/errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}}},{"code":"422","schemaId":"components/schemas/errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/properties/post-properties"}],"panels":[]}]},"httpPath":"/properties"},{"label":"Get property","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/properties/get-property","routeSlug":"/v1/properties/get-property","metadata":{"seo":{"title":"Get property","description":"Retrieve a property by its id. Returns 404 if the property does not exist or belongs to another organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-property","name":"Get property","isWebhook":false,"pointer":"/paths/~1properties~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get property","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a property by its id. Returns 404 if the property does not exist or belongs to another organization."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer-token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key issued to your organization. Send it as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_16","description":"Id of the property.","required":true}],"pointer":"/paths/~1properties~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Checkr-Tenant-Version","in":"header","schemaId":"schema_19","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CalVer-dated API version to pin behavior to (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2026-04-29"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). When omitted,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the request is served by the newest supported version. Unknown values return 422."},"children":[]}]}]}]}],"pointer":"/paths/~1properties~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/properties/{id}","servers":[{"url":"https://tenant.checkr.com/api","description":"Checkr Tenant API"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_16"}],"query":[],"querystring":[],"header":[{"name":"Checkr-Tenant-Version","in":"header","required":false,"schemaId":"schema_19"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer-token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404","422"],"pointer":"/properties/{id}","href":"properties/get-property","openApiOperationId":"get-property","summary":"Get property"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://tenant.checkr.com/api","description":"Checkr Tenant API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/property"}},"schemaId":"components/schemas/property"},{"code":"401","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}},"schemaId":"components/schemas/errors"},{"code":"403","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}},"schemaId":"components/schemas/errors"},{"code":"404","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}},"schemaId":"components/schemas/errors"},{"code":"422","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}},"schemaId":"components/schemas/errors"}],"pointer":"/paths/~1properties~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/property","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/property"}}},{"code":"401","schemaId":"components/schemas/errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}}},{"code":"403","schemaId":"components/schemas/errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}}},{"code":"404","schemaId":"components/schemas/errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}}},{"code":"422","schemaId":"components/schemas/errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/properties/get-property"}],"panels":[]}]},"httpPath":"/properties/{id}"}],"content":{"contentType":"group","meta":{"name":"Properties"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Properties","showPageActions":true},{"nodeType":"markdoc","content":"Rental addresses you screen applicants for. Properties can be created on their own and reused across orders, or created inline when an order is placed."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/properties","summary":"List properties","prefix":{"name":"get","color":"get"},"badges":[],"link":"/properties/get-properties","deprecated":false},{"title":"/properties","summary":"Create property","prefix":{"name":"post","color":"post"},"badges":[],"link":"/properties/post-properties","deprecated":false},{"title":"/properties/{id}","summary":"Get property","prefix":{"name":"get","color":"get"},"badges":[],"link":"/properties/get-property","deprecated":false}]}]}]}]}},{"type":"group","label":"Applicants","link":"/v1/applicants","routeSlug":"/v1/applicants","items":[{"label":"List applicants","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/applicants/get-applicants","routeSlug":"/v1/applicants/get-applicants","metadata":{"seo":{"title":"List applicants","description":"List the applicants owned by your organization, newest first. Theresponse is paginated — see next_href / previous_href for walkingthrough pages."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-applicants","name":"List applicants","isWebhook":false,"pointer":"/paths/~1applicants/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List applicants","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List the applicants owned by your organization, newest first. The"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"response is paginated — see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_href"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"previous_href"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for walking"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"through pages."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer-token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key issued to your organization. Send it as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_16","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Opaque pagination token. Omit on the first request, then follow the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_href"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"previous_href"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" URLs in the response — those URLs already"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"have the correct cursor encoded. Cursors from one endpoint are not valid"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"on another. An invalid cursor returns 422."},"children":[]}]}]}]},{"name":"per_page","in":"query","schemaId":"schema_17","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Page size. Defaults to 25; the maximum is 100. The chosen size is preserved"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_href"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"previous_href"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", so you only need to set it on the first"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"request of a walk."},"children":[]}]}]}]}],"pointer":"/paths/~1applicants/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Checkr-Tenant-Version","in":"header","schemaId":"schema_19","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CalVer-dated API version to pin behavior to (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2026-04-29"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). When omitted,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the request is served by the newest supported version. Unknown values return 422."},"children":[]}]}]}]}],"pointer":"/paths/~1applicants/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/applicants","servers":[{"url":"https://tenant.checkr.com/api","description":"Checkr Tenant API"}],"parameters":{"path":[],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_16"},{"name":"per_page","in":"query","required":false,"schemaId":"schema_17"}],"querystring":[],"header":[{"name":"Checkr-Tenant-Version","in":"header","required":false,"schemaId":"schema_19"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer-token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","422"],"pointer":"/applicants","href":"applicants/get-applicants","openApiOperationId":"get-applicants","summary":"List applicants"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://tenant.checkr.com/api","description":"Checkr Tenant API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/applicant-list"}},"schemaId":"components/schemas/applicant-list"},{"code":"401","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}},"schemaId":"components/schemas/errors"},{"code":"403","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}},"schemaId":"components/schemas/errors"},{"code":"422","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}},"schemaId":"components/schemas/errors"}],"pointer":"/paths/~1applicants/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/applicant-list","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/applicant-list"}}},{"code":"401","schemaId":"components/schemas/errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}}},{"code":"403","schemaId":"components/schemas/errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}}},{"code":"422","schemaId":"components/schemas/errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/applicants/get-applicants"}],"panels":[]}]},"httpPath":"/applicants"},{"label":"Create applicant","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/applicants/post-applicants","routeSlug":"/v1/applicants/post-applicants","metadata":{"seo":{"title":"Create applicant","description":"Create a new applicant record from identity fields. Applicants createddirectly via this endpoint can later be referenced by applicant_idwhen creating an order, instead of supplying identity fields inlineagain."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"post-applicants","name":"Create applicant","isWebhook":false,"pointer":"/paths/~1applicants/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create applicant","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a new applicant record from identity fields. Applicants created"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"directly via this endpoint can later be referenced by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"applicant_id"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"when creating an order, instead of supplying identity fields inline"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"again."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"phone_number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is optional; accepts any common US format. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dob"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ssn"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"are also optional at create time — if they are not supplied here, the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"applicant will be prompted to provide them when they complete the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"consent form on their first order."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer-token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key issued to your organization. Send it as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Checkr-Tenant-Version","in":"header","schemaId":"schema_19","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CalVer-dated API version to pin behavior to (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2026-04-29"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). When omitted,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the request is served by the newest supported version. Unknown values return 422."},"children":[]}]}]}]}],"pointer":"/paths/~1applicants/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_29"}},"schemaId":"schema_29","pointer":"/paths/~1applicants/post/requestBody","description":"The request body for creating a new applicant."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/applicants","servers":[{"url":"https://tenant.checkr.com/api","description":"Checkr Tenant API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Checkr-Tenant-Version","in":"header","required":false,"schemaId":"schema_19"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer-token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_29"}},"responseCodes":["201","401","403","422"],"pointer":"/applicants","href":"applicants/post-applicants","openApiOperationId":"post-applicants","summary":"Create applicant"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://tenant.checkr.com/api","description":"Checkr Tenant API"}],"schemaId":"schema_29","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_29"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/applicant"}},"schemaId":"components/schemas/applicant"},{"code":"401","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}},"schemaId":"components/schemas/errors"},{"code":"403","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}},"schemaId":"components/schemas/errors"},{"code":"422","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}},"schemaId":"components/schemas/errors"}],"pointer":"/paths/~1applicants/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/applicant","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/applicant"}}},{"code":"401","schemaId":"components/schemas/errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}}},{"code":"403","schemaId":"components/schemas/errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}}},{"code":"422","schemaId":"components/schemas/errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/applicants/post-applicants"}],"panels":[]}]},"httpPath":"/applicants"},{"label":"Get applicant","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/applicants/get-applicant","routeSlug":"/v1/applicants/get-applicant","metadata":{"seo":{"title":"Get applicant","description":"Retrieve an applicant by its id. Returns 404 if the applicant does not exist or belongs to another organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-applicant","name":"Get applicant","isWebhook":false,"pointer":"/paths/~1applicants~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get applicant","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve an applicant by its id. Returns 404 if the applicant does not exist or belongs to another organization."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer-token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key issued to your organization. Send it as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_16","description":"Id of the applicant.","required":true}],"pointer":"/paths/~1applicants~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Checkr-Tenant-Version","in":"header","schemaId":"schema_19","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CalVer-dated API version to pin behavior to (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2026-04-29"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). When omitted,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the request is served by the newest supported version. Unknown values return 422."},"children":[]}]}]}]}],"pointer":"/paths/~1applicants~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/applicants/{id}","servers":[{"url":"https://tenant.checkr.com/api","description":"Checkr Tenant API"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_16"}],"query":[],"querystring":[],"header":[{"name":"Checkr-Tenant-Version","in":"header","required":false,"schemaId":"schema_19"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer-token","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404","422"],"pointer":"/applicants/{id}","href":"applicants/get-applicant","openApiOperationId":"get-applicant","summary":"Get applicant"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://tenant.checkr.com/api","description":"Checkr Tenant API"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/applicant"}},"schemaId":"components/schemas/applicant"},{"code":"401","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}},"schemaId":"components/schemas/errors"},{"code":"403","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}},"schemaId":"components/schemas/errors"},{"code":"404","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}},"schemaId":"components/schemas/errors"},{"code":"422","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}},"schemaId":"components/schemas/errors"}],"pointer":"/paths/~1applicants~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/applicant","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/applicant"}}},{"code":"401","schemaId":"components/schemas/errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}}},{"code":"403","schemaId":"components/schemas/errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}}},{"code":"404","schemaId":"components/schemas/errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}}},{"code":"422","schemaId":"components/schemas/errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/errors"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/applicants/get-applicant"}],"panels":[]}]},"httpPath":"/applicants/{id}"}],"content":{"contentType":"group","meta":{"name":"Applicants"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Applicants","showPageActions":true},{"nodeType":"markdoc","content":"People being screened. Applicants can be created on their own and attached to an order later, or created inline when an order is placed. Each applicant attaches to at most one order."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/applicants","summary":"List applicants","prefix":{"name":"get","color":"get"},"badges":[],"link":"/applicants/get-applicants","deprecated":false},{"title":"/applicants","summary":"Create applicant","prefix":{"name":"post","color":"post"},"badges":[],"link":"/applicants/post-applicants","deprecated":false},{"title":"/applicants/{id}","summary":"Get applicant","prefix":{"name":"get","color":"get"},"badges":[],"link":"/applicants/get-applicant","deprecated":false}]}]}]}]}},{"type":"separator","label":"Products","content":null},{"type":"group","label":"Products","link":"/v1/products","routeSlug":"/v1/products","items":[{"type":"link","label":"credit-report","link":"/v1/products/credit-report","routeSlug":"/v1/products/credit-report","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"credit-report"},"seo":{"title":"credit-report"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"credit-report","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/credit-report"},"children":[]}]}]}},{"type":"link","label":"criminal-history","link":"/v1/products/criminal-history","routeSlug":"/v1/products/criminal-history","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"criminal-history"},"seo":{"title":"criminal-history"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"criminal-history","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/criminal-history"},"children":[]}]}]}},{"type":"link","label":"eviction-history","link":"/v1/products/eviction-history","routeSlug":"/v1/products/eviction-history","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"eviction-history"},"seo":{"title":"eviction-history"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"eviction-history","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/eviction-history"},"children":[]}]}]}},{"type":"link","label":"global-watchlist","link":"/v1/products/global-watchlist","routeSlug":"/v1/products/global-watchlist","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"global-watchlist"},"seo":{"title":"global-watchlist"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"global-watchlist","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/global-watchlist"},"children":[]}]}]}},{"type":"link","label":"identity-verification","link":"/v1/products/identity-verification","routeSlug":"/v1/products/identity-verification","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"identity-verification"},"seo":{"title":"identity-verification"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"identity-verification","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/identity-verification"},"children":[]}]}]}},{"type":"link","label":"income-verification","link":"/v1/products/income-verification","routeSlug":"/v1/products/income-verification","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"income-verification"},"seo":{"title":"income-verification"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"income-verification","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/income-verification"},"children":[]}]}]}},{"type":"link","label":"sex-offender-registry","link":"/v1/products/sex-offender-registry","routeSlug":"/v1/products/sex-offender-registry","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"sex-offender-registry"},"seo":{"title":"sex-offender-registry"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"sex-offender-registry","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/sex-offender-registry"},"children":[]}]}]}}],"content":{"contentType":"group","meta":{"name":"Products"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Products","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The individual products that make up a screening order. Each product is run as a separate report item and appears on the report keyed by its type ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"criminal_history"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"credit_report"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eviction_history"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identity_verification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"income_verification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sex_offender_registry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"global_watchlist"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"credit-report","link":"/products/credit-report","deprecated":false},{"title":"criminal-history","link":"/products/criminal-history","deprecated":false},{"title":"eviction-history","link":"/products/eviction-history","deprecated":false},{"title":"global-watchlist","link":"/products/global-watchlist","deprecated":false},{"title":"identity-verification","link":"/products/identity-verification","deprecated":false},{"title":"income-verification","link":"/products/income-verification","deprecated":false},{"title":"sex-offender-registry","link":"/products/sex-offender-registry","deprecated":false}]}]}]}]}},{"type":"separator","label":"Webhooks","content":null},{"type":"group","label":"Webhooks","link":"/v1/webhooks","routeSlug":"/v1/webhooks","items":[{"label":"report.completed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/v1/webhooks/paths/report.completed/post","routeSlug":"/v1/webhooks/paths/report.completed/post","metadata":{"seo":{"title":"report.completed","description":"Sent when an order has finished processing and the full report isavailable. See the Webhooks guide for deliverysemantics, retry behavior, and signature verification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"report.completed","isWebhook":true,"pointer":"/paths/report.completed/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"report.completed","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent when an order has finished processing and the full report is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"available. See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for delivery"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"semantics, retry behavior, and signature verification."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer-token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key issued to your organization. Send it as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Tenant-Signature","in":"header","schemaId":"schema_30","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Signature header in the form "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"t=<unix_ts>,v1=<hmac_sha256_hex>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/webhooks#verifying-signatures"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verifying signatures"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"User-Agent","in":"header","schemaId":"schema_31","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CheckrTenant/1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/report.completed/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/webhook-event-report-completed"}},"schemaId":"components/schemas/webhook-event-report-completed","pointer":"/paths/report.completed/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"report.completed","servers":[{"url":"https://tenant.checkr.com/api","description":"Checkr Tenant API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Tenant-Signature","in":"header","required":true,"example":"t=1714414933,v1=8d2bf3ac0f9e1b2d4c5a6e7f8091a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9","schemaId":"schema_30"},{"name":"User-Agent","in":"header","required":true,"schemaId":"schema_31"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer-token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/webhook-event-report-completed"}},"responseCodes":["2XX"],"pointer":"report.completed","href":"webhooks/paths/report.completed/post","summary":"report.completed"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://tenant.checkr.com/api","description":"Checkr Tenant API"}],"schemaId":"components/schemas/webhook-event-report-completed","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/webhook-event-report-completed"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2XX","description":"Any 2xx response acknowledges the delivery. Non-2xx responses, network\nerrors, and timeouts are treated as failures and retried with exponential\nbackoff.\n"}],"pointer":"/paths/report.completed/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/paths/report.completed/post"}],"panels":[]}]},"httpPath":"report.completed"},{"label":"report.product.completed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/v1/webhooks/paths/report.product.completed/post","routeSlug":"/v1/webhooks/paths/report.product.completed/post","metadata":{"seo":{"title":"report.product.completed","description":"Sent when a product finishes processing and results are available on the report."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"report.product.completed","isWebhook":true,"pointer":"/paths/report.product.completed/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"report.product.completed","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Sent when a product finishes processing and results are available on\nthe report.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer-token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key issued to your organization. Send it as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Tenant-Signature","in":"header","schemaId":"schema_30","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Signature header in the form "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"t=<unix_ts>,v1=<hmac_sha256_hex>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/webhooks#verifying-signatures"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verifying signatures"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"User-Agent","in":"header","schemaId":"schema_31","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CheckrTenant/1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/report.product.completed/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/webhook-event-report-product-completed"}},"schemaId":"components/schemas/webhook-event-report-product-completed","pointer":"/paths/report.product.completed/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"report.product.completed","servers":[{"url":"https://tenant.checkr.com/api","description":"Checkr Tenant API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Tenant-Signature","in":"header","required":true,"example":"t=1714414933,v1=8d2bf3ac0f9e1b2d4c5a6e7f8091a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9","schemaId":"schema_30"},{"name":"User-Agent","in":"header","required":true,"schemaId":"schema_31"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer-token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/webhook-event-report-product-completed"}},"responseCodes":["2XX"],"pointer":"report.product.completed","href":"webhooks/paths/report.product.completed/post","summary":"report.product.completed"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://tenant.checkr.com/api","description":"Checkr Tenant API"}],"schemaId":"components/schemas/webhook-event-report-product-completed","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/webhook-event-report-product-completed"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2XX","description":"Any 2xx response acknowledges the delivery. Non-2xx responses, network\nerrors, and timeouts are treated as failures and retried with exponential\nbackoff.\n"}],"pointer":"/paths/report.product.completed/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/paths/report.product.completed/post"}],"panels":[]}]},"httpPath":"report.product.completed"},{"label":"order.applicant.visited","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/v1/webhooks/paths/order.applicant.visited/post","routeSlug":"/v1/webhooks/paths/order.applicant.visited/post","metadata":{"seo":{"title":"order.applicant.visited","description":"Sent when the applicant visits the apply link for an order at any time before they complete the application."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"order.applicant.visited","isWebhook":true,"pointer":"/paths/order.applicant.visited/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"order.applicant.visited","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Sent when the applicant visits the apply link for an order at any time\nbefore they complete the application.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer-token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key issued to your organization. Send it as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Tenant-Signature","in":"header","schemaId":"schema_30","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Signature header in the form "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"t=<unix_ts>,v1=<hmac_sha256_hex>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/webhooks#verifying-signatures"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verifying signatures"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"User-Agent","in":"header","schemaId":"schema_31","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CheckrTenant/1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/order.applicant.visited/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/webhook-event-order-applicant-visited"}},"schemaId":"components/schemas/webhook-event-order-applicant-visited","pointer":"/paths/order.applicant.visited/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"order.applicant.visited","servers":[{"url":"https://tenant.checkr.com/api","description":"Checkr Tenant API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Tenant-Signature","in":"header","required":true,"example":"t=1714414933,v1=8d2bf3ac0f9e1b2d4c5a6e7f8091a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9","schemaId":"schema_30"},{"name":"User-Agent","in":"header","required":true,"schemaId":"schema_31"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer-token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/webhook-event-order-applicant-visited"}},"responseCodes":["2XX"],"pointer":"order.applicant.visited","href":"webhooks/paths/order.applicant.visited/post","summary":"order.applicant.visited"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://tenant.checkr.com/api","description":"Checkr Tenant API"}],"schemaId":"components/schemas/webhook-event-order-applicant-visited","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/webhook-event-order-applicant-visited"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2XX","description":"Any 2xx response acknowledges the delivery. Non-2xx responses, network\nerrors, and timeouts are treated as failures and retried with exponential\nbackoff.\n"}],"pointer":"/paths/order.applicant.visited/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/paths/order.applicant.visited/post"}],"panels":[]}]},"httpPath":"order.applicant.visited"},{"label":"order.applicant.started","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/v1/webhooks/paths/order.applicant.started/post","routeSlug":"/v1/webhooks/paths/order.applicant.started/post","metadata":{"seo":{"title":"order.applicant.started","description":"Sent when the applicant consents to and starts the screening application."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"order.applicant.started","isWebhook":true,"pointer":"/paths/order.applicant.started/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"order.applicant.started","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Sent when the applicant consents to and starts the screening application.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer-token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key issued to your organization. Send it as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Tenant-Signature","in":"header","schemaId":"schema_30","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Signature header in the form "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"t=<unix_ts>,v1=<hmac_sha256_hex>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/webhooks#verifying-signatures"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verifying signatures"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"User-Agent","in":"header","schemaId":"schema_31","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CheckrTenant/1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/order.applicant.started/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/webhook-event-order-applicant-started"}},"schemaId":"components/schemas/webhook-event-order-applicant-started","pointer":"/paths/order.applicant.started/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"order.applicant.started","servers":[{"url":"https://tenant.checkr.com/api","description":"Checkr Tenant API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Tenant-Signature","in":"header","required":true,"example":"t=1714414933,v1=8d2bf3ac0f9e1b2d4c5a6e7f8091a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9","schemaId":"schema_30"},{"name":"User-Agent","in":"header","required":true,"schemaId":"schema_31"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer-token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/webhook-event-order-applicant-started"}},"responseCodes":["2XX"],"pointer":"order.applicant.started","href":"webhooks/paths/order.applicant.started/post","summary":"order.applicant.started"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://tenant.checkr.com/api","description":"Checkr Tenant API"}],"schemaId":"components/schemas/webhook-event-order-applicant-started","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/webhook-event-order-applicant-started"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2XX","description":"Any 2xx response acknowledges the delivery. Non-2xx responses, network\nerrors, and timeouts are treated as failures and retried with exponential\nbackoff.\n"}],"pointer":"/paths/order.applicant.started/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/paths/order.applicant.started/post"}],"panels":[]}]},"httpPath":"order.applicant.started"},{"label":"order.applicant.completed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/v1/webhooks/paths/order.applicant.completed/post","routeSlug":"/v1/webhooks/paths/order.applicant.completed/post","metadata":{"seo":{"title":"order.applicant.completed","description":"Sent when the applicant finishes and submits the application."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"order.applicant.completed","isWebhook":true,"pointer":"/paths/order.applicant.completed/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"order.applicant.completed","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Sent when the applicant finishes and submits the application.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer-token","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key issued to your organization. Send it as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Tenant-Signature","in":"header","schemaId":"schema_30","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Signature header in the form "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"t=<unix_ts>,v1=<hmac_sha256_hex>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/webhooks#verifying-signatures"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verifying signatures"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"User-Agent","in":"header","schemaId":"schema_31","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CheckrTenant/1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/order.applicant.completed/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/webhook-event-order-applicant-completed"}},"schemaId":"components/schemas/webhook-event-order-applicant-completed","pointer":"/paths/order.applicant.completed/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"order.applicant.completed","servers":[{"url":"https://tenant.checkr.com/api","description":"Checkr Tenant API"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Tenant-Signature","in":"header","required":true,"example":"t=1714414933,v1=8d2bf3ac0f9e1b2d4c5a6e7f8091a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9","schemaId":"schema_30"},{"name":"User-Agent","in":"header","required":true,"schemaId":"schema_31"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer-token","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/webhook-event-order-applicant-completed"}},"responseCodes":["2XX"],"pointer":"order.applicant.completed","href":"webhooks/paths/order.applicant.completed/post","summary":"order.applicant.completed"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://tenant.checkr.com/api","description":"Checkr Tenant API"}],"schemaId":"components/schemas/webhook-event-order-applicant-completed","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/webhook-event-order-applicant-completed"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2XX","description":"Any 2xx response acknowledges the delivery. Non-2xx responses, network\nerrors, and timeouts are treated as failures and retried with exponential\nbackoff.\n"}],"pointer":"/paths/order.applicant.completed/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/paths/order.applicant.completed/post"}],"panels":[]}]},"httpPath":"order.applicant.completed"}],"content":{"contentType":"group","meta":{"name":"Webhooks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Webhooks","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Outbound HTTP callbacks Checkr Tenant sends to your endpoints when"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"lifecycle events happen. See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"delivery semantics, retries, and signature verification."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"report.completed","summary":"report.completed","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/paths/report.completed/post","deprecated":false},{"title":"report.product.completed","summary":"report.product.completed","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/paths/report.product.completed/post","deprecated":false},{"title":"order.applicant.visited","summary":"order.applicant.visited","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/paths/order.applicant.visited/post","deprecated":false},{"title":"order.applicant.started","summary":"order.applicant.started","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/paths/order.applicant.started/post","deprecated":false},{"title":"order.applicant.completed","summary":"order.applicant.completed","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/paths/order.applicant.completed/post","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/order":{"id":"components/schemas/order","kind":"json-schema","title":"order","data":{"type":"object","description":"A screening order placed for an applicant against a property.","properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier for the order. Use this value in subsequent API calls; it is stable for the lifetime of the order. Test-mode IDs carry a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" infix (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ord_test_TUyYsLnyTbG3xv9hONJF7w"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"); live-mode IDs have no infix."},"children":[]}]}]}],"example":"ord_TUyYsLnyTbG3xv9hONJF7w"},"live_mode":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether this order was created with a live API key ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or a test API key ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Test-mode orders are inert: they route to canned provider responses and do not produce billable activity. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/testing"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Testing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}],"example":true},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current state of the order in its lifecycle:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"waiting_for_applicant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — invitation sent; awaiting the applicant's consent and information"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — applicant submitted consent and information; screening is in progress"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — screening is complete and the report is available"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — terminated before completion"},"children":[]}]}]}]}],"enum":["waiting_for_applicant","pending","completed","canceled"]},"package":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Slug of the screening package on the order, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"starter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"essential"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"add_on_products":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Slugs of add-on products run on the order in addition to the ones bundled into "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"package"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Sorted alphabetically; empty if none were requested."},"children":[]}]}]}],"uniqueItems":true,"items":{"type":"string","minLength":1},"example":["identity_verification"]},"property_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the property record this order is screening for. Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?include=property"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to embed the full property object."},"children":[]}]}]}],"example":"pr_K9dM2pXqR4vN8tLZbWyHJa"},"applicant_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the applicant being screened. Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?include=applicant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to embed the full applicant object."},"children":[]}]}]}],"example":"ap_F3hQ7wEsLp2xBnVcRuMyTk"},"application_url":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Absolute URL for the applicant apply flow ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://…/apply/<token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned only while the order status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"waiting_for_applicant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"live-mode orders, and in test mode only for the Hudson Green"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"applicant-experience profile (other test applicants auto-submit and skip"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the apply flow — see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/testing#applicant-experience-in-test-mode"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Testing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ordinary test-mode profiles. When the apply flow runs, Checkr emails this"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"link to the applicant; in live mode, if a phone number is present, Checkr"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"also texts it. Integrators may share "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" themselves."},"children":[]}]}]}],"example":"https://tenant.checkr.com/apply/K7P2MX","format":"uri"},"property":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded property object. Only returned when the request includes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?include=property"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"$ref":"#/components/schemas/property"},"applicant":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded applicant object. Only returned when the request includes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?include=applicant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"$ref":"#/components/schemas/applicant"},"created_at":{"type":"string","format":"date-time","description":"Timestamp the order was accepted by the API."},"completed_at":{"type":["string","null"],"format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp the order reached the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status. Null while in any earlier state, and remains null if the order is canceled."},"children":[]}]}]}]},"canceled_at":{"type":["string","null"],"format":"date-time","description":"Timestamp the order was canceled. Null unless the order was canceled."}}}},"components/schemas/order-list":{"id":"components/schemas/order-list","kind":"json-schema","title":"order-list","data":{"description":"A page of orders wrapped in the standard list envelope.","allOf":[{"$ref":"#/components/schemas/list-envelope"},{"type":"object","properties":{"data":{"type":"array","description":"Orders on this page, ordered newest first.","items":{"$ref":"#/components/schemas/order"}}}}]}},"components/schemas/report":{"id":"components/schemas/report","kind":"json-schema","title":"report","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The screening results produced for an order. A report bundles together one"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"report item per product included in the order. Each report item is keyed by its"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product type ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"criminal_history"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"credit_report"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eviction_history"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identity_verification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"income_verification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sex_offender_registry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"global_watchlist"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":");"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"products not included in the order are returned as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier for the report. Use this value in subsequent API calls; it is stable for the lifetime of the report. Test-mode IDs carry a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" infix (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rp_test_K9dM2pXqR4vN8tLZbWyHJa"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"); live-mode IDs have no infix."},"children":[]}]}]}],"example":"rp_K9dM2pXqR4vN8tLZbWyHJa"},"live_mode":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether this report was produced from an order created with a live API key ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or a test API key ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Test-mode reports are produced from canned provider responses and do not reflect real screening activity. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/testing"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Testing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}],"example":true},"order_id":{"type":"string","description":"Identifier of the order this report was produced for.","example":"ord_TUyYsLnyTbG3xv9hONJF7w"},"created_at":{"type":"string","format":"date-time","description":"Timestamp the report was created."},"updated_at":{"type":"string","format":"date-time","description":"Timestamp the report was last updated."},"criminal_history":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Report item for the criminal history product, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this product was not included in the order."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/criminal-history"},{"type":"null"}]},"credit_report":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Report item for the credit report product, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this product was not included in the order."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/credit-report"},{"type":"null"}]},"eviction_history":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Report item for the eviction history product, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this product was not included in the order."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/eviction-history"},{"type":"null"}]},"identity_verification":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Report item for the identity verification product, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this product was not included in the order."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/identity-verification"},{"type":"null"}]},"income_verification":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Report item for the income verification product, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this product was not included in the order."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/income-verification"},{"type":"null"}]},"sex_offender_registry":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Report item for the sex offender registry product, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this product was not included in the order."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/sex-offender-registry"},{"type":"null"}]},"global_watchlist":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Report item for the global watchlist product, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this product was not included in the order."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/global-watchlist"},{"type":"null"}]}}}},"components/schemas/report-item-base":{"id":"components/schemas/report-item-base","kind":"json-schema","title":"report-item-base","data":{"type":"object","description":"Fields shared by every report item on a report.","properties":{"id":{"type":"string","description":"Unique identifier for the report item.","example":"rpi_F3hQ7wEsLp2xBnVcRuMyTk"},"status":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resolved status of this report item:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clear"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — no findings that warrant adjudication"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"consider"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — findings present; the result should be reviewed before making a decision"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Null while the report item is still being assembled and no results have been recorded yet."},"children":[]}]}]}],"enum":["clear","consider",null]},"created_at":{"type":"string","format":"date-time","description":"Timestamp the report item was created."},"updated_at":{"type":"string","format":"date-time","description":"Timestamp the report item was last updated."}}}},"components/schemas/criminal-history":{"id":"components/schemas/criminal-history","kind":"json-schema","title":"criminal-history","data":{"x-tags":["Products"],"description":"Report item for the criminal history product, containing findings sourced from court records across the jurisdictions searched for the applicant.","allOf":[{"$ref":"#/components/schemas/report-item-base"},{"type":"object","properties":{"records":{"type":"array","description":"One entry per criminal case returned for the applicant, with the source it came from and the person it was matched to. Empty if no records were found.","items":{"$ref":"#/components/schemas/criminal-record"}}}}]}},"components/schemas/criminal-case":{"id":"components/schemas/criminal-case","kind":"json-schema","title":"criminal-case","data":{"type":"object","description":"A single criminal case returned by the search, including the charges filed under it.","properties":{"case_number":{"type":["string","null"],"description":"Court-assigned case number identifying the matter."},"court_name":{"type":["string","null"],"description":"Name of the court that handled the case."},"county":{"type":["string","null"],"description":"County the case was filed in."},"state":{"type":["string","null"],"description":"Two-letter USPS state code where the case was filed.","example":"CA"},"file_date":{"type":["string","null"],"format":"date","description":"Date the case was filed with the court."},"charges":{"type":"array","description":"Charges filed under this case.","items":{"$ref":"#/components/schemas/criminal-charge"}}}}},"components/schemas/criminal-charge":{"id":"components/schemas/criminal-charge","kind":"json-schema","title":"criminal-charge","data":{"type":"object","description":"A single charge filed under a criminal case, with its disposition (the court's resolution of the charge).","properties":{"charge":{"type":["string","null"],"description":"Description of the charge as recorded by the court."},"statute":{"type":["string","null"],"description":"Statute or legal code the charge was filed under."},"type":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Classification of the charge as reported by the underlying court source."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commonly one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"felony"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"misdemeanor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"infraction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"violation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"but other source-specific classifications may pass through."},"children":[]}]}]}]},"offense_date":{"type":["string","null"],"format":"date","description":"Date the alleged offense occurred."},"charge_date":{"type":["string","null"],"format":"date","description":"Date the charge was filed."},"arrest_date":{"type":["string","null"],"format":"date","description":"The date the person was arrested."},"disposition":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The court's most recent resolution of the charge. Returns the normalized"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disposition_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value when available, otherwise the raw text as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reported by the source. Charges with multiple court actions surface"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the latest one by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disposition_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"disposition_type":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Normalized disposition category. Known values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"conviction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dismissed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expunged"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transferred"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"warrant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merged"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"alternative_adjudication"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unclassified"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Additional values may be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"introduced over time. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when no normalized category could be assigned."},"children":[]}]}]}]},"disposition_date":{"type":["string","null"],"format":"date","description":"Date the most recent disposition was entered."}}}},"components/schemas/credit-report":{"id":"components/schemas/credit-report","kind":"json-schema","title":"credit-report","data":{"x-tags":["Products"],"description":"Report item for the credit report product, containing findings sourced from a soft credit pull. The pull does not affect the applicant's credit score.","allOf":[{"$ref":"#/components/schemas/report-item-base"},{"type":"object","properties":{"credit_file_status":{"type":["string"],"enum":["available","frozen","not_found","thin_file"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the request for a credit file from a credit bureau. When the value is not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"available"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", a credit report cannot be generated."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"available"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit file was returned and a score was generated."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"frozen"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applicant's credit file is frozen with the credit bureau."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not_found"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Either the applicant has never used credit, or there's a mismatch in the information provided."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"thin_file"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A credit report could not be generated because the applicant has little or no credit history."},"children":[]}]}]}]}]}]}],"example":"available"},"credit_score":{"type":["integer","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applicant's credit score. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"credit_file_status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"available"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":712},"credit_summary":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Aggregate summary of the applicant's credit profile. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"credit_file_status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"available"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/credit-summary"},{"type":"null"}]}}}]}},"components/schemas/credit-summary":{"id":"components/schemas/credit-summary","kind":"json-schema","title":"credit-summary","data":{"type":"object","description":"Aggregate metrics describing the applicant's credit profile at the time the report was produced.","properties":{"total_accounts":{"type":"integer","description":"Total number of credit accounts on file for the applicant.","example":8},"on_time_payment_rate":{"type":["number","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Share of payments made on time across all reporting accounts, expressed as a value between "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":0.97},"average_account_age_months":{"type":["integer","null"],"description":"Average age of the applicant's credit accounts, in months.","example":84},"credit_utilization":{"$ref":"#/components/schemas/credit-utilization"},"estimated_monthly_payment_cents":{"type":["integer","null"],"description":"Estimated total monthly payment across all reporting accounts, in cents.","example":142000},"collections_count":{"type":"integer","description":"Number of accounts in collections.","example":0},"charge_offs_count":{"type":"integer","description":"Number of accounts charged off by the lender.","example":0},"bankruptcies_count":{"type":"integer","description":"Number of bankruptcies on file.","example":0},"payment_timeline":{"type":"array","description":"Month-by-month payment behavior over the lookback window, ordered oldest to newest.","items":{"$ref":"#/components/schemas/credit-timeline-entry"}}}}},"components/schemas/credit-utilization":{"id":"components/schemas/credit-utilization","kind":"json-schema","title":"credit-utilization","data":{"type":"object","description":"Revolving credit utilization across the applicant's reporting accounts.","properties":{"rate":{"type":["number","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ratio of balance to limit, expressed as a value between "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":0.23},"balance_cents":{"type":["integer","null"],"description":"Total revolving balance, in cents."},"limit_cents":{"type":["integer","null"],"description":"Total revolving credit limit, in cents."}}}},"components/schemas/credit-timeline-entry":{"id":"components/schemas/credit-timeline-entry","kind":"json-schema","title":"credit-timeline-entry","data":{"type":"object","description":"Payment behavior aggregated for a single month.","properties":{"month":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Month the entry covers, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"example":"2026-02"},"on_time_count":{"type":"integer","description":"Number of payments made on time during the month."},"late_count":{"type":"integer","description":"Number of payments made late during the month."},"on_time_rate":{"type":["number","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Share of payments made on time during the month, expressed as a value between "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}}},"components/schemas/eviction-history":{"id":"components/schemas/eviction-history","kind":"json-schema","title":"eviction-history","data":{"x-tags":["Products"],"description":"Report item for the eviction history product, containing findings sourced from civil court filings across the jurisdictions searched for the applicant.","allOf":[{"$ref":"#/components/schemas/report-item-base"},{"type":"object","properties":{"records":{"type":"array","description":"One entry per eviction filing returned for the applicant. Empty if no records were found.","items":{"$ref":"#/components/schemas/eviction-record"}}}}]}},"components/schemas/eviction-record":{"id":"components/schemas/eviction-record","kind":"json-schema","title":"eviction-record","data":{"type":"object","description":"A single eviction filing, including the judgment outcome if one was entered.","properties":{"case_number":{"type":["string","null"],"description":"Court-assigned case number identifying the filing."},"plaintiff":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Party that filed the eviction action — typically the landlord or property manager."},"children":[]}]}]}]},"file_date":{"type":["string","null"],"format":"date","description":"Date the case was filed with the court."},"judgment":{"type":["string","null"],"description":"Judgment outcome as reported by the underlying court source. Free-form text; vocabulary varies across jurisdictions. Null if no judgment has been entered."},"judgment_date":{"type":["string","null"],"format":"date","description":"Date the judgment was entered. Null if no judgment has been entered."},"judgment_amount_cents":{"type":["integer","null"],"description":"Monetary amount of the judgment, in cents. Null if no monetary judgment was entered."}}}},"components/schemas/identity-verification":{"id":"components/schemas/identity-verification","kind":"json-schema","title":"identity-verification","data":{"x-tags":["Products"],"description":"Report item for the identity verification product, containing the outcome of a analysis of a user provided document and a selfie.\n","allOf":[{"$ref":"#/components/schemas/report-item-base"},{"type":"object","properties":{"document_type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Classification of the identity document that was submitted, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if no results are available yet."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/idv-document-type"},{"type":"null"}]},"document_data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data extracted from the submitted document, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if no results are available yet."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/idv-document-data"},{"type":"null"}]},"consider_reasons":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reasons the verification resulted in a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"consider"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status. Empty when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clear"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each entry represents a distinct rejection category explaining why the verification did not pass."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/idv-consider-reason"}},"documents_zip_url":{"type":["string","null"],"format":"uri","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Signed URL to download the document images captured during the verification session as a ZIP archive, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if no document images are available. The URL is single-use and short-lived, and needs no authentication of its own — it can be handed straight to a browser."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To retrieve these images alongside the report's other documents in one authenticated call, use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/get-report-documents-zip"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /reports/{id}/documents/zip"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}],"example":"https://tenant.checkr.com/api/identity_verification_documents/idvd_K9dM2pXqR4vN8tLZbWyHJa"}}}]}},"components/schemas/idv-document-type":{"id":"components/schemas/idv-document-type","kind":"json-schema","title":"idv-document-type","data":{"type":"object","description":"Classification of the identity document submitted by the applicant.","properties":{"type":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of identity document submitted. Possible values include: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Drivers License"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identification Card"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Passport"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Passport Card"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Permanent Resident Card"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Unknown"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"Drivers License"},"country":{"type":["string","null"],"description":"Three-letter ISO 3166-1 alpha-3 country code of the issuing country.","example":"USA"},"state":{"type":["string","null"],"description":"Two-letter state or province code of the issuing authority, if applicable. Null for nationally-issued documents such as passports.","example":"CA"}}}},"components/schemas/idv-document-data":{"id":"components/schemas/idv-document-data","kind":"json-schema","title":"idv-document-data","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data extracted from the identity document. All fields are nullable — extraction is best-effort and not every document type exposes every field."},"children":[]}]}]}],"properties":{"first_name":{"type":["string","null"],"description":"Given name as printed on the document.","example":"Jane"},"last_name":{"type":["string","null"],"description":"Family name (surname) as printed on the document.","example":"Public"},"full_name":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Full name as printed on the document. May differ from the concatenation of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"first_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for documents that use a single name field."},"children":[]}]}]}],"example":"Jane Public"},"dob":{"type":["string","null"],"format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date of birth printed on the document, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"example":"1990-05-14"},"document_number":{"type":["string","null"],"description":"Identifier assigned to the document by the issuing authority (e.g. driver's license number, passport number).","example":"D1234567"},"issue_date":{"type":["string","null"],"format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date the document was issued, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"example":"2020-01-01"},"expiration_date":{"type":["string","null"],"format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date the document expires, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"example":"2028-01-01"},"address":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Address printed on the document, parsed into components, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if no address was extracted."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/idv-document-address"},{"type":"null"}]}}}},"components/schemas/idv-document-address":{"id":"components/schemas/idv-document-address","kind":"json-schema","title":"idv-document-address","data":{"type":"object","description":"Address extracted from the identity document, parsed into components.","properties":{"street":{"type":["string","null"],"description":"Primary street line.","example":"123 Example Street"},"street2":{"type":["string","null"],"description":"Secondary street line (unit, suite, apartment, etc.).","example":"Suite 200"},"city":{"type":["string","null"],"description":"City.","example":"Denver"},"state":{"type":["string","null"],"description":"Two-letter state or province code.","example":"CO"},"country":{"type":["string","null"],"description":"Three-letter ISO 3166-1 alpha-3 country code.","example":"USA"},"zip":{"type":["string","null"],"description":"Postal code.","example":"80033"}}}},"components/schemas/idv-consider-reason":{"id":"components/schemas/idv-consider-reason","kind":"json-schema","title":"idv-consider-reason","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A single rejection category explaining why the identity verification resulted in a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"consider"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status."},"children":[]}]}]}],"properties":{"category":{"type":"string","description":"Machine-readable rejection category. Stable across releases; safe to branch on.","enum":["name_mismatch","selfie_mismatch","doc_expired","doc_not_authentic","doc_unsupported","image_quality","duplicate_identity","suspected_fraud","other"]},"label":{"type":"string","description":"Human-readable description of the rejection category.","example":"Document expired"}}}},"components/schemas/income-verification":{"id":"components/schemas/income-verification","kind":"json-schema","title":"income-verification","data":{"x-tags":["Products"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Report item for income verification, containing the applicant's income streams and the totals across them. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"income_streams"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" lists every stream identified, and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"verification_method"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" says what the findings were drawn from."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Which fields carry a figure depends on the evidence behind each stream, and every field below says when it is null."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/report-item-base"},{"type":"object","properties":{"verification_method":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How the income was verified. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bank"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the applicant linked their accounts, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"document"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when they uploaded proof of income. Null before verification begins."},"children":[]}]}]}],"example":"document"},"current_as_of":{"type":["string","null"],"format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How current the findings are. For a bank connection, the date the account data was last refreshed. For documents, the last day the documents cover, which is not the date they were uploaded: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"documents[].submitted_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" says that."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Null when only tax forms were supplied, which report a completed tax year rather than recent activity."},"children":[]}]}]}]},"current_month_income":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Net and estimated gross income across all active income streams for the current month, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if no results are available yet."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/income-current-month"},{"type":"null"}]},"summary":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Aggregate income across all active and inactive streams, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if no results are available yet. The window each total covers is given in the schema below."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/income-summary"},{"type":"null"}]},"accounts":{"type":"array","description":"One entry per financial-institution account the applicant connected. Empty when the income was verified by document, and when no results are available yet.","items":{"$ref":"#/components/schemas/income-account"}},"income_streams":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Every income stream identified, whichever method established it. A stream a connected account produced names that account in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"account_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; one a document established names its evidence in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"document_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Streams from a connected account also appear under that account in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accounts[].income_streams"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The two are the same objects, so read one or the other, never both, or the totals double."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/income-stream"}},"documents":{"type":"array","description":"Proof-of-income documents the applicant uploaded, oldest first. Empty when the income was verified by bank connection, and when document income verification is not enabled for your account.","items":{"$ref":"#/components/schemas/income-document"}},"consider_reasons":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reasons the verification resulted in a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"consider"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status. Empty when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clear"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each entry represents a distinct category explaining why the verification did not pass."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/income-consider-reason"}}}}]}},"components/schemas/income-current-month":{"id":"components/schemas/income-current-month","kind":"json-schema","title":"income-current-month","data":{"type":"object","description":"Income across all active streams for the current month.","properties":{"month":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The month the totals cover, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"example":"2024-11"},"net_cents":{"type":["integer","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Net income across all active streams for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", in cents."},"children":[]}]}]}],"example":224546},"estimated_gross_cents":{"type":["integer","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Estimated gross income across all active streams for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", in cents."},"children":[]}]}]}],"example":269455}}}},"components/schemas/income-summary":{"id":"components/schemas/income-summary","kind":"json-schema","title":"income-summary","data":{"type":"object","description":"Aggregate income across all active and inactive streams.\n\nTwelve months for a bank connection. For documents, the monthly averages divide whatever the documents cover, and the totals come from a single tax year, so the two are never comparable and must not be summed. The window behind each figure is on the streams that produced it.\n","properties":{"average_monthly_net_cents":{"type":["integer","null"],"description":"Average monthly net income across all active and inactive streams, in cents.","example":393492},"total_past_12_months_net_cents":{"type":["integer","null"],"description":"Total net income across all active and inactive streams over the past twelve months, in cents.","example":4721906},"average_monthly_estimated_gross_cents":{"type":["integer","null"],"description":"Average monthly estimated gross income across all active and inactive streams, in cents.","example":472191},"total_past_12_months_estimated_gross_cents":{"type":["integer","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total estimated gross income across all active and inactive streams over the past twelve months, in cents."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For document income this is what the applicant's tax forms report for a single tax year, counting only forms for the latest year supplied, and it is stated by those forms rather than estimated. The stream carrying it gives the year in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":5666287}}}},"components/schemas/income-account":{"id":"components/schemas/income-account","kind":"json-schema","title":"income-account","data":{"type":"object","description":"A single financial-institution account the applicant connected for income verification.","properties":{"id":{"type":"string","description":"Unique identifier for the connected account.","example":"ivac_K9dM2pXqR4vN8tLZbWyHJa"},"financial_institution_name":{"type":["string","null"],"description":"Name of the financial institution holding the account.","example":"Bank of America"},"account_type":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of account as reported by the financial institution. Free-form text; vocabulary varies across institutions (typical values include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Checking"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Savings"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Investment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401k"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"Checking"},"account_number_last4":{"type":["string","null"],"description":"Last four digits of the account number. The full number is never returned.","example":"5131"},"account_owners":{"type":"array","description":"Names listed as owners on the account. May contain multiple entries for jointly held accounts. Empty if no owners were reported.","items":{"type":"string","example":"Amy Brierly"}},"active_from":{"type":["string","null"],"format":"date","description":"Date the account first became active (the earliest activity visible to the analysis)."},"current_balance_cents":{"type":["integer","null"],"description":"Current balance on the account at the time the report was produced, in cents.","example":1266287},"average_monthly_balance_cents":{"type":["integer","null"],"description":"Average monthly balance on the account over the analysis window, in cents.","example":664336},"insufficient_funds_count_last_6_months":{"type":["integer","null"],"description":"Number of insufficient-funds (NSF) fee events on the account in the last six months.","example":2},"insufficient_funds_count_last_12_months":{"type":["integer","null"],"description":"Number of insufficient-funds (NSF) fee events on the account in the report's analysis window (last 12 months).","example":2},"last_insufficient_funds_fee_at":{"type":["string","null"],"format":"date","description":"Date of the most recent insufficient-funds (NSF) fee on the account. Day-precision only. Null if no NSF fees have been observed in the analysis window."},"income_streams":{"type":"array","description":"Recurring deposit streams identified on this account. Empty if no recurring income was detected.","items":{"$ref":"#/components/schemas/income-stream"}}}}},"components/schemas/income-stream":{"id":"components/schemas/income-stream","kind":"json-schema","title":"income-stream","data":{"type":"object","description":"Income from one payer, for example the paychecks from one employer.\n\nWhich figures are filled follows from what established the stream, and each field below says when it is null.\n","properties":{"id":{"type":"string","description":"Unique identifier for the income stream.","example":"ist_K9dM2pXqR4vN8tLZbWyHJa"},"account_id":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The connected account this stream was identified on, matching an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accounts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Null for a stream a document established."},"children":[]}]}]}],"example":"ivac_K9dM2pXqR4vN8tLZbWyHJa"},"source":{"type":["string","null"],"description":"Best-effort label for who the deposits come from, typically derived from the deposit memo (for example, an employer name).","example":"Enterprise One"},"stream_type":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Classification of the stream as reported by the analysis. Free-form text — typical values include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Paycheck"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Deposit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". May be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when no transactions have been attributed to the stream."},"children":[]}]}]}],"example":"Paycheck"},"status":{"type":["string","null"],"description":"Whether the income stream is still arriving at the time of the report. Free-form text.","example":"Active"},"start_date":{"type":["string","null"],"format":"date","description":"First day this stream's evidence covers. Null for a stream from a connected account, which reports months rather than days."},"end_date":{"type":["string","null"],"format":"date","description":"Last day this stream's evidence covers. Null for a stream from a connected account, which reports months rather than days."},"stream_history_days":{"type":["integer","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Days of evidence behind this stream, counting a day covered by two documents once. Null for a stream from a connected account, which reports months. Exact, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stream_history_months"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is rounded and never zero, so a fortnight and a full month both read as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" there."},"children":[]}]}]}],"example":29},"start_month":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The same span at month precision. First month deposits were attributed to this stream, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"example":"2022-09"},"end_month":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Last month deposits were attributed to this stream, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. Null when the stream is still receiving deposits at the time of the report."},"children":[]}]}]}],"example":"2024-08"},"stream_history_months":{"type":["integer","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of months between "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (or the report date, if the stream is still active). Rounded, so prefer "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stream_history_days"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for arithmetic."},"children":[]}]}]}],"example":25},"deposit_frequency":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Typical cadence between deposits in this stream. Free-form text; may be a range (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2-3 days"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") when the cadence is irregular."},"children":[]}]}]}],"example":"14 days"},"consistency_score":{"type":["string","null"],"description":"Qualitative score reflecting how consistently deposits in this stream are classified as income. Free-form text.","example":"High"},"net_annual_cents":{"type":["integer","null"],"description":"Net annual income from this stream, in cents. Measured over a full year, so only a stream from a connected account reports one.","example":5666287},"estimated_gross_annual_cents":{"type":["integer","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Estimated gross annual income from this stream, in cents. Inferred from net deposits, so only a stream from a connected account reports one."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Null for a stream a document established, whose gross was stated rather than estimated and is reported in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gross_cents"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":6799544},"average_monthly_net_cents":{"type":["integer","null"],"description":"Average monthly net income from this stream, in cents. Null for a stream a tax form established, since a yearly total divided by twelve is not a measured month.","example":248096},"last_30_days_net_cents":{"type":["integer","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Net income from this stream in the most recent month observed, in cents. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is valid. Null for a stream a document established, which reports no month-by-month detail."},"children":[]}]}]}],"example":224500},"net_income_by_month":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Per-month breakdown of net deposits from this stream. Empty if no transactions have been observed in the analysis window."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always empty for a stream a document established, which reports a total for the period it covers and no month-by-month detail. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"current_month_income"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is null for the same reason."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/income-monthly-net"}},"net_cents":{"type":["integer","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Net income from this stream between "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", in cents. Null when nothing reported the net this payer deposited, which is the case for a tax form."},"children":[]}]}]}],"example":382000},"gross_cents":{"type":["integer","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gross income from this stream between "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", in cents. Not estimated: a paystub and a tax form both state gross outright."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Null when no document stated it, which is the case for a stream established only by bank statements, since deposits are net."},"children":[]}]}]}],"example":480000},"document_ids":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The documents in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"documents"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that established this stream. Empty for a stream from a connected account."},"children":[]}]}]}],"items":{"type":"string","example":"inc_K9dM2pXqR4vN8tLZbWyHJa"}}}}},"components/schemas/income-document":{"id":"components/schemas/income-document","kind":"json-schema","title":"income-document","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A proof-of-income document the applicant uploaded, and what the analysis made of it."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A document appears once it has been accepted, so one the applicant replaced never does. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"checks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" records what was verified about its contents; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"risk_assessment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" records whether it appears genuine, which is judged separately, so a document can pass every check and still carry a high risk level. Whether a document contributed to the reported income follows from its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"risk_assessment.level"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier for the document, and what "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"income_streams[].document_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" refers to."},"children":[]}]}]}],"example":"inc_K9dM2pXqR4vN8tLZbWyHJa"},"document_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What the document was classified as. Known values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paystub"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"w2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1099"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bank_statement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the type could not be established, in which case no income was taken"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"from it. Additional types may be introduced over time."},"children":[]}]}]}],"example":"paystub"},"filename":{"type":["string","null"],"description":"Name of the file as the applicant uploaded it.","example":"paystub-june.pdf"},"content_type":{"type":["string","null"],"description":"MIME type of the document.","example":"application/pdf"},"period_start_date":{"type":["string","null"],"format":"date","description":"First day the document covers. A tax form covers its year, January 1 to December 31. Null when the dates could not be read."},"period_end_date":{"type":["string","null"],"format":"date","description":"Last day the document covers."},"risk_assessment":{"description":"Whether the document appears genuine. Null until the analysis has assessed it, which is not the same as a clean assessment.","oneOf":[{"$ref":"#/components/schemas/income-document-risk-assessment"},{"type":"null"}]},"checks":{"$ref":"#/components/schemas/income-document-checks"},"download_url":{"type":"string","format":"uri","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoint that returns the document itself — "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/get-report-document"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /reports/{id}/documents/{document_id}/download"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It requires the same authentication as any other request, so the URL alone grants no access. It addresses the document by id and does not expire. To fetch every document for the report in one call instead, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/get-report-documents-zip"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /reports/{id}/documents/zip"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"https://api.checkrtenant.com/v1/reports/rp_K9dM2pXqR4vN8tLZbWyHJa/documents/inc_K9dM2pXqR4vN8tLZbWyHJa/download"},"submitted_at":{"type":["string","null"],"format":"date-time","description":"When the applicant submitted the document. Null if it has not been submitted."},"created_at":{"type":"string","format":"date-time","description":"When the document was first uploaded."}}}},"components/schemas/income-document-risk-assessment":{"id":"components/schemas/income-document-risk-assessment","kind":"json-schema","title":"income-document-risk-assessment","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The result of document risk analysis: whether the document shows signs of having been altered,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"read from its metadata, its appearance, its internal consistency and other risk indicators."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Separate from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"checks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which are upload time validations to ensure that the applicant uploads"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"usable income documents."},"children":[]}]}]}],"properties":{"level":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How strong the indicators of alteration are."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Level"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What was detected"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used for reported income"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"low"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No significant anomalies were detected. Contents are internally consistent and metadata matches the conventions for the type."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"medium"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minor inconsistencies, unusual metadata, or formatting that departs from the norm. Suggestive rather than conclusive."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"high"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Clear indicators, such as digital editing, structural or layout flaws, or signs of synthetic generation."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not assessed: the analysis has not run yet, or this document type cannot be assessed."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Known values are the three above; additional values may be introduced over time. Treat an"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"unrecognised level as not counted rather than as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"low"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"low"},"summary":{"type":["string","null"],"description":"Plain-language account of what the assessment found, naming the specific signals behind the level.","example":"No fraud signals detected. Document metadata and content are consistent with a genuine bank export."}}}},"components/schemas/income-document-checks":{"id":"components/schemas/income-document-checks","kind":"json-schema","title":"income-document-checks","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What was verified about the document when it was uploaded. Each check is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when it passed, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when it failed, and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when it has not been evaluated, which is not the same as a failure."},"children":[]}]}]}],"properties":{"document_type":{"type":["boolean","null"],"description":"Whether the document is a type accepted as proof of income."},"name_match":{"type":["boolean","null"],"description":"Whether a name on the document matches the applicant."},"recency":{"type":["boolean","null"],"description":"Whether the document is recent enough to describe the applicant's current income."}}}},"components/schemas/income-monthly-net":{"id":"components/schemas/income-monthly-net","kind":"json-schema","title":"income-monthly-net","data":{"type":"object","description":"Net deposits from an income stream for a single month.","properties":{"month":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The month the totals cover, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"example":"2024-05"},"net_cents":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Net deposits attributed to the stream during "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", in cents. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is valid."},"children":[]}]}]}],"example":269552},"transaction_count":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of deposit transactions attributed to the stream during "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":2}}}},"components/schemas/sex-offender-registry":{"id":"components/schemas/sex-offender-registry","kind":"json-schema","title":"sex-offender-registry","data":{"x-tags":["Products"],"description":"Report item for the sex offender registry product, containing matches found against state sex offender registries.","allOf":[{"$ref":"#/components/schemas/report-item-base"},{"type":"object","properties":{"records":{"type":"array","description":"One entry per registry match returned for the applicant. Empty if no matches were found.","items":{"$ref":"#/components/schemas/record"}}}}]}},"components/schemas/global-watchlist":{"id":"components/schemas/global-watchlist","kind":"json-schema","title":"global-watchlist","data":{"x-tags":["Products"],"description":"Report item for the global watchlist product, containing matches found against sanctions, healthcare, and other regulatory watchlists.","allOf":[{"$ref":"#/components/schemas/report-item-base"},{"type":"object","properties":{"records":{"type":"array","description":"One entry per watchlist match returned for the applicant. Empty if no matches were found.","items":{"$ref":"#/components/schemas/record"}}}}]}},"components/schemas/record":{"id":"components/schemas/record","kind":"json-schema","title":"record","data":{"type":"object","description":"A single registry or watchlist match, including the source the match came from, the matched person's identifying details, and any criminal cases associated with the match.","properties":{"source":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The registry or watchlist that returned the match. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the upstream source returned no source metadata."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/record-source"},{"type":"null"}]},"person":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifying details of the matched person as recorded by the source. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the upstream source returned no person details."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/record-person"},{"type":"null"}]},"cases":{"type":"array","description":"Criminal cases associated with this match. Often empty for watchlist matches that do not carry court data.","items":{"$ref":"#/components/schemas/criminal-case"}}}}},"components/schemas/record-source":{"id":"components/schemas/record-source","kind":"json-schema","title":"record-source","data":{"type":"object","description":"The registry, watchlist, or other source that produced a match.","properties":{"name":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Human-readable name of the source (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"California Megan's Law Registry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OFAC SDN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"category":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Category of source the match came from. Common values include"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sex offender registry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sanctions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"healthcare"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and similar"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"regulatory list categories."},"children":[]}]}]}]},"county":{"type":["string","null"],"description":"County the source covers, when applicable."},"state":{"type":["string","null"],"description":"Two-letter USPS state code the source covers, when applicable.","example":"CA"}}}},"components/schemas/record-person":{"id":"components/schemas/record-person","kind":"json-schema","title":"record-person","data":{"type":"object","description":"Identifying details of the matched person as recorded by the registry or watchlist. Fields are populated only when the source provides them.","properties":{"full_name":{"type":["string","null"],"description":"Full name as recorded by the source."},"first_name":{"type":["string","null"],"description":"Given name as recorded by the source."},"middle_name":{"type":["string","null"],"description":"Middle name as recorded by the source."},"last_name":{"type":["string","null"],"description":"Family name as recorded by the source."},"dob":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date of birth as recorded by the source. Returned in truncated ISO 8601"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"form: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when only a partial date is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"known. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the source does not publish a date of birth."},"children":[]}]}]}]},"gender":{"type":["string","null"],"description":"Gender as recorded by the source."},"height":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Height in US units (feet and inches, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5'10\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"weight":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Weight in US units (pounds, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"175 lb"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"hair_color":{"type":["string","null"],"description":"Hair color as recorded by the source."},"eye_color":{"type":["string","null"],"description":"Eye color as recorded by the source."},"race":{"type":["string","null"],"description":"Race as recorded by the source. May be withheld by source jurisdiction."},"photo_urls":{"type":"array","description":"URLs of any photos published by the source. Empty array when none are available.","items":{"type":"string","format":"uri"}},"aliases":{"type":"array","description":"Other names the matched person is known by, as recorded by the source.","items":{"type":"string"}},"addresses":{"type":"array","description":"Addresses associated with the matched person, as recorded by the source.","items":{"$ref":"#/components/schemas/record-address"}}}}},"components/schemas/record-address":{"id":"components/schemas/record-address","kind":"json-schema","title":"record-address","data":{"type":"object","description":"An address associated with a registry or watchlist match.","properties":{"street":{"type":["string","null"],"description":"Street line, including house/building number and street name. Apartment or unit numbers may be included."},"city":{"type":["string","null"],"description":"City or municipality."},"state":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Two-letter US state code. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for non-US addresses."},"children":[]}]}]}],"example":"CA"},"zipcode":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"US Postal Service ZIP code (5-digit or 9-digit ZIP+4). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for non-US addresses."},"children":[]}]}]}]},"country":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Two-letter ISO country code. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"US"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when omitted by the source."},"children":[]}]}]}],"example":"US"},"county":{"type":["string","null"],"description":"County the address is located in."}}}},"components/schemas/property":{"id":"components/schemas/property","kind":"json-schema","title":"property","data":{"description":"A property record representing the rental address an order is screening for.","allOf":[{"type":"object","properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier for the property record. Use this value in subsequent API calls; it is stable for the lifetime of the property. Test-mode IDs carry a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" infix (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pr_test_K9dM2pXqR4vN8tLZbWyHJa"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"); live-mode IDs have no infix."},"children":[]}]}]}],"example":"pr_K9dM2pXqR4vN8tLZbWyHJa"},"name":{"type":["string","null"],"description":"Optional human-readable label for the property (e.g. a building or unit nickname). When set, it is shown to applicants and used in email/SMS communications in addition to the property address.","example":"Sunset Apartments"}}},{"$ref":"#/components/schemas/property-address"},{"type":"object","properties":{"created_at":{"type":"string","format":"date-time","description":"Timestamp the property record was created."}}}]}},"components/schemas/property-address":{"id":"components/schemas/property-address","kind":"json-schema","title":"property-address","data":{"type":"object","description":"The mailing-address fields shared between order creation requests and the embedded property object returned in responses.","properties":{"street":{"type":"string","description":"Street line of the property address (number and street name).","example":"1234 Market St"},"unit":{"type":["string","null"],"description":"Optional unit, suite, or apartment designator within the building.","example":"Apt 4B"},"city":{"type":"string","description":"City the property is located in.","example":"San Francisco"},"state":{"type":"string","description":"Two-letter USPS state or territory code (uppercase).","example":"CA"},"zipcode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"5-digit US ZIP code or ZIP+4."},"children":[]}]}]}],"example":"94103"}}}},"components/schemas/property-list":{"id":"components/schemas/property-list","kind":"json-schema","title":"property-list","data":{"description":"A page of properties wrapped in the standard list envelope.","allOf":[{"$ref":"#/components/schemas/list-envelope"},{"type":"object","properties":{"data":{"type":"array","description":"Properties on this page, ordered newest first.","items":{"$ref":"#/components/schemas/property"}}}}]}},"components/schemas/applicant":{"id":"components/schemas/applicant","kind":"json-schema","title":"applicant","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An applicant record. The full SSN is never returned — only the masked form."},"children":[]}]}]}],"allOf":[{"type":"object","properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier for the applicant record. Use this value in subsequent API calls; it is stable for the lifetime of the applicant. Test-mode IDs carry a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_test_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" infix (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ap_test_F3hQ7wEsLp2xBnVcRuMyTk"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"); live-mode IDs have no infix."},"children":[]}]}]}],"example":"ap_F3hQ7wEsLp2xBnVcRuMyTk"}}},{"$ref":"#/components/schemas/applicant-identity"},{"type":"object","properties":{"first_name":{"type":"string","minLength":1,"maxLength":50,"description":"Applicant's given name."},"last_name":{"type":"string","minLength":1,"maxLength":50,"description":"Applicant's family name."},"dob":{"type":["string","null"],"format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date of birth in ISO-8601 format ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Null if not yet collected."},"children":[]}]}]}],"example":"1990-05-14"},"phone_number":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Phone number on file for the applicant in E.164 format (US numbers"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"only), or null if none has been collected. Accepted on input in any"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"common format (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"(555) 123-4567"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"555-123-4567"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"); normalized"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"before storage."},"children":[]}]}]}],"example":"+15551234567"},"ssn":{"type":["string","null"],"description":"Masked Social Security Number (last four digits only). Null in responses if no SSN is on file. The full SSN is never returned.","example":"XXX-XX-6789"},"created_at":{"type":"string","format":"date-time","description":"Timestamp the applicant record was created."}}}]}},"components/schemas/applicant-identity":{"id":"components/schemas/applicant-identity","kind":"json-schema","title":"applicant-identity","data":{"type":"object","description":"Identity fields returned for an applicant record. Values should match the applicant's legal identity.","properties":{"full_name":{"type":"string","minLength":2,"maxLength":100,"description":"Applicant's full legal name as it appears on government-issued ID.","example":"Jane Public"},"email":{"type":"string","format":"email","description":"Email address used to contact the applicant about their screening.","example":"jane@example.com"}}}},"components/schemas/applicant-list":{"id":"components/schemas/applicant-list","kind":"json-schema","title":"applicant-list","data":{"description":"A page of applicants wrapped in the standard list envelope.","allOf":[{"$ref":"#/components/schemas/list-envelope"},{"type":"object","properties":{"data":{"type":"array","description":"Applicants on this page, ordered newest first.","items":{"$ref":"#/components/schemas/applicant"}}}}]}},"components/schemas/list-envelope":{"id":"components/schemas/list-envelope","kind":"json-schema","title":"list-envelope","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wrapper returned by every list endpoint. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array is ordered newest"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"first. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_href"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"previous_href"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to walk forward and backward"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"through results — both are absolute URLs that already encode the cursor and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"per_page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for you, and are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" at the ends of the list."},"children":[]}]}]}],"properties":{"object":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for list responses."},"children":[]}]}]}],"enum":["list"]},"count":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total number of records in the underlying collection (across all pages), not the size of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"next_href":{"type":["string","null"],"format":"uri","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Absolute URL of the next page (older records), or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this is the last page."},"children":[]}]}]}]},"previous_href":{"type":["string","null"],"format":"uri","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Absolute URL of the previous page (newer records), or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this is the first page."},"children":[]}]}]}]}}}},"components/schemas/webhook-event":{"id":"components/schemas/webhook-event","kind":"json-schema","title":"webhook-event","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common envelope for every webhook delivery. Concrete event types narrow"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field and the shape of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique event id. Stable across retries — use it for idempotency on the receiving side."},"children":[]}]}]}],"example":"evt_K9dM2pXqR4vN8tLZbWyHJa"},"object":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"event"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for webhook payloads."},"children":[]}]}]}],"enum":["event"]},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event type. See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the current catalog."},"children":[]}]}]}],"example":"report.completed"},"created_at":{"type":"string","format":"date-time","description":"UTC timestamp the event was created, in ISO-8601 format."},"data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event-specific payload. Shape varies by event type — see the concrete event schemas below."},"children":[]}]}]}]}}}},"components/schemas/webhook-event-report-completed":{"id":"components/schemas/webhook-event-report-completed","kind":"json-schema","title":"webhook-event-report-completed","data":{"description":"Sent when an order has finished processing and the full report is\navailable.\n","allOf":[{"$ref":"#/components/schemas/webhook-event"},{"type":"object","properties":{"type":{"type":"string","enum":["report.completed"]},"data":{"type":"object","description":"Reference to the completed report and the parent order.","properties":{"id":{"type":"string","description":"Id of the completed report.","example":"rp_F3hQ7wEsLp2xBnVcRuMyTk"},"order_id":{"type":"string","description":"Id of the parent order.","example":"ord_WHImYp5RjqUxBowWilloQ"}}}}}]}},"components/schemas/webhook-event-report-product-completed":{"id":"components/schemas/webhook-event-report-product-completed","kind":"json-schema","title":"webhook-event-report-product-completed","data":{"description":"Sent when a product finishes processing and results are available on\nthe report.\n","allOf":[{"$ref":"#/components/schemas/webhook-event"},{"type":"object","properties":{"type":{"type":"string","enum":["report.product.completed"]},"data":{"type":"object","description":"Reference to the completed product result and the parent report.","properties":{"id":{"type":"string","description":"Id of the completed product result.","example":"rpi_abc123def456ghi7"},"report_id":{"type":"string","description":"Id of the parent report.","example":"rp_F3hQ7wEsLp2xBnVcRuMyTk"},"product":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the product that finished (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"criminal_history"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"credit_report"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eviction_history"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"criminal_history"}}}}}]}},"components/schemas/webhook-event-order-applicant-visited":{"id":"components/schemas/webhook-event-order-applicant-visited","kind":"json-schema","title":"webhook-event-order-applicant-visited","data":{"description":"Sent when the applicant visits the apply link for an order at any time\nbefore they complete the application.\n","allOf":[{"$ref":"#/components/schemas/webhook-event"},{"type":"object","properties":{"type":{"type":"string","enum":["order.applicant.visited"]},"data":{"type":"object","description":"Reference to the applicant and order.","properties":{"id":{"type":"string","description":"Id of the applicant.","example":"ap_9f8e7d6c5b4a3210"},"order_id":{"type":"string","description":"Id of the order.","example":"ord_WHImYp5RjqUxBowWilloQ"}}}}}]}},"components/schemas/webhook-event-order-applicant-started":{"id":"components/schemas/webhook-event-order-applicant-started","kind":"json-schema","title":"webhook-event-order-applicant-started","data":{"description":"Sent when the applicant consents to and starts the screening application.\n","allOf":[{"$ref":"#/components/schemas/webhook-event"},{"type":"object","properties":{"type":{"type":"string","enum":["order.applicant.started"]},"data":{"type":"object","description":"Reference to the applicant and order.","properties":{"id":{"type":"string","description":"Id of the applicant.","example":"ap_9f8e7d6c5b4a3210"},"order_id":{"type":"string","description":"Id of the order.","example":"ord_WHImYp5RjqUxBowWilloQ"}}}}}]}},"components/schemas/webhook-event-order-applicant-completed":{"id":"components/schemas/webhook-event-order-applicant-completed","kind":"json-schema","title":"webhook-event-order-applicant-completed","data":{"description":"Sent when the applicant finishes and submits the application.\n","allOf":[{"$ref":"#/components/schemas/webhook-event"},{"type":"object","properties":{"type":{"type":"string","enum":["order.applicant.completed"]},"data":{"type":"object","description":"Reference to the applicant and order.","properties":{"id":{"type":"string","description":"Id of the applicant.","example":"ap_9f8e7d6c5b4a3210"},"order_id":{"type":"string","description":"Id of the order.","example":"ord_WHImYp5RjqUxBowWilloQ"}}}}}]}},"components/schemas/errors":{"id":"components/schemas/errors","kind":"json-schema","title":"errors","data":{"type":"object","description":"Standard error response envelope. Every non-2xx response uses this shape. Validation failures (HTTP 422) may include multiple entries, one per offending field; other errors return a single entry.","properties":{"errors":{"type":"array","description":"One or more errors describing why the request failed.","items":{"type":"object","properties":{"code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Machine-readable error type. Stable across releases; safe to branch on. Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorization_error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (401)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"forbidden"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (403)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not_found_error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (404)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"validation_error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (422)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"internal_error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (500)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"no_payment_method"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (402) — no card on file for the organization. Add a card in Settings → Billing, then retry the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card_declined"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (402) — the saved card was declined. Update the card on file or use a different one, then retry the request with a new "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Idempotency-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authentication_required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (402) — the saved card requires interactive authentication and cannot be charged. Replace the saved card with one that supports off-session payments."},"children":[]}]}]}]}]},"detail":{"type":"string","description":"Human-readable explanation of this specific occurrence."},"source":{"type":"object","description":"Pointer to the input that caused the error. Returned for validation errors to identify the offending field; absent otherwise.","properties":{"pointer":{"type":"string","description":"JSON Pointer path to the offending attribute.","example":"/email"}}}}}}}}},"components/schemas/criminal-record":{"id":"components/schemas/criminal-record","kind":"json-schema","title":"criminal-record","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A single criminal case returned by the search, enriched with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"source"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" it came from and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"person"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" it was matched to. Combines the case data (case number, court, charges) with source and person blocks."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/criminal-case"},{"type":"object","properties":{"source":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The court or other source that produced the record. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the upstream source returned no source metadata."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/record-source"},{"type":"null"}]},"person":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifying details of the person the record was matched to. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the upstream source returned no person details."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/record-person"},{"type":"null"}]}}}]}},"components/schemas/income-consider-reason":{"id":"components/schemas/income-consider-reason","kind":"json-schema","title":"income-consider-reason","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A single category explaining why the income verification resulted in a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"consider"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Category"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Label"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"applicant_declined"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applicant declined verification"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The applicant declined to connect their bank account(s) to verify their income."},"children":[]}]}]}]}]}]}],"properties":{"category":{"type":"string","description":"Machine-readable category. Stable across releases; safe to branch on.","enum":["applicant_declined"]},"label":{"type":"string","description":"Human-readable description of the category.","example":"Applicant declined verification"}}}},"schema_16":{"kind":"json-schema","data":{"type":"string"},"id":"schema_16"},"schema_17":{"kind":"json-schema","data":{"type":"integer","minimum":1,"maximum":100,"default":25},"id":"schema_17"},"schema_18":{"kind":"json-schema","data":{"type":"string","example":"property,applicant"},"id":"schema_18"},"schema_19":{"kind":"json-schema","data":{"type":"string","enum":["2026-04-29"]},"id":"schema_19"},"schema_20":{"kind":"json-schema","data":{"type":"string","minLength":1,"maxLength":255,"example":"8e1bce8f-2a5e-4f7e-9f61-7e1f3e6e0c7b"},"id":"schema_20"},"schema_21":{"kind":"json-schema","data":{"type":"object","properties":{"order":{"type":"object","description":"Attributes for the new order.","properties":{"package":{"type":"string","description":"Slug of the screening package to run. Determines which checks are performed and the price charged.","enum":["starter","essential"]},"property_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Id of an existing property record (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pr_K9dM2pXqR4vN8tLZbWyHJa"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"owned by your organization. Mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"property"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns 404 if the property does not exist or belongs to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"another organization."},"children":[]}]}]}],"example":"pr_K9dM2pXqR4vN8tLZbWyHJa"},"property":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Address of the rental property the applicant is being"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"screened for. Mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"property_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the address matches an existing property in your"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"organization, the existing property is reused and no new"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"record is created — see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /properties"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the exact"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"matching rules. The order's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"property_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reflects whichever id was used (existing or new)."},"children":[]}]}]}],"allOf":[{"type":"object","properties":{"name":{"type":["string","null"],"description":"Optional human-readable label for the property (e.g. a building or unit nickname). When set, it is shown to applicants and used in email/SMS communications in addition to the property address.","example":"Sunset Apartments"}}},{"$ref":"#/components/schemas/property-address"},{"type":"object","required":["street","city","state","zipcode"]}]},"applicant_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Id of an existing applicant record (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ap_F3hQ7wEsLp2xBnVcRuMyTk"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"owned by your organization. Mutually exclusive with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"applicant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Returns 404 if the applicant does not exist or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"belongs to another organization, and 422 if the applicant is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"already attached to an order — applicants are 1:1 with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"orders."},"children":[]}]}]}],"example":"ap_F3hQ7wEsLp2xBnVcRuMyTk"},"applicant":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identity fields for the person being screened. A new"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"applicant record is created from these fields. Mutually"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"applicant_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"first_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last_name"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"are preferred; legacy clients may still send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"full_name"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"instead. Do not send both name forms. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is always"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"required at create time. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dob"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and/or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ssn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are omitted,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the applicant will be prompted to provide them when they"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"complete the consent form. Values must match the applicant's"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"legal identity."},"children":[]}]}]}],"allOf":[{"type":"object","properties":{"email":{"type":"string","format":"email","description":"Email address used to contact the applicant about their screening.","example":"jane@example.com"},"dob":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date of birth in ISO-8601 format ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"1990-05-14"},"phone_number":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mobile phone number to contact the applicant about"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"their screening. US numbers only. Accepted in any"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"common format (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"(415) 555-0100"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"415-555-0100"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+14155550100"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"); normalized to E.164 before storage."},"children":[]}]}]}],"example":"415-555-0100"},"ssn":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applicant's full 9-digit US Social Security Number. Accepted with or without dashes ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"123-45-6789"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"123456789"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Subsequent reads only return a masked form."},"children":[]}]}]}],"example":"123-45-6789"}},"required":["email"],"oneOf":[{"title":"Split applicant name","type":"object","properties":{"first_name":{"type":"string","minLength":1,"maxLength":50,"description":"Applicant's given name.","example":"Jane"},"last_name":{"type":"string","minLength":1,"maxLength":50,"description":"Applicant's family name.","example":"Doe"}},"required":["first_name","last_name"],"not":{"properties":{"full_name":{}},"required":["full_name"]}},{"title":"Legacy full applicant name","type":"object","properties":{"full_name":{"type":"string","minLength":2,"maxLength":100,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Legacy alternative to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"first_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"first_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; when split on the first whitespace, it must produce at least two name parts and each resulting part must be 1 to 50 characters."},"children":[]}]}]}],"example":"Jane Doe"}},"required":["full_name"],"not":{"anyOf":[{"properties":{"first_name":{}},"required":["first_name"]},{"properties":{"last_name":{}},"required":["last_name"]}]}}]}]},"add_on_products":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional add-on products to run on the order in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"addition to the ones bundled into "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"package"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Unknown or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"non-add-on products return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"422 validation_error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"uniqueItems":true,"items":{"type":"string","minLength":1},"example":["identity_verification"]}},"required":["package"]}},"required":["order"]},"id":"schema_21"},"schema_22":{"kind":"json-schema","data":{"type":"string","format":"binary"},"id":"schema_22"},"schema_23":{"kind":"json-schema","data":{"type":"object","properties":{"Content-Disposition":{"type":"string","description":"Attachment disposition with the report's canonical filename."},"Cache-Control":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"private, no-store"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the PDF contains PII and must not"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"be cached by intermediaries or the client."},"children":[]}]}]}]}}},"id":"schema_23"},"schema_24":{"kind":"json-schema","data":{"type":"object","properties":{"Content-Disposition":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attachment disposition with a filename of"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"documents-<report_id>.zip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"Cache-Control":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"private, no-store"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the archive contains PII and must"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not be cached by intermediaries or the client."},"children":[]}]}]}]}}},"id":"schema_24"},"schema_25":{"kind":"json-schema","data":{"type":"object","properties":{"Content-Disposition":{"type":"string","description":"Attachment disposition with the filename the applicant\nuploaded the document under.\n"},"Cache-Control":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"private, no-store"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the document contains PII and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"must not be cached by intermediaries or the client."},"children":[]}]}]}]}}},"id":"schema_25"},"schema_26":{"kind":"json-schema","data":{"type":"object","properties":{"property":{"description":"Address of the rental property.","allOf":[{"type":"object","properties":{"name":{"type":["string","null"],"description":"Optional human-readable label for the property (e.g. a building or unit nickname). When set, it is shown to applicants and used in email/SMS communications in addition to the property address.","example":"Sunset Apartments"}}},{"$ref":"#/components/schemas/property-address"},{"type":"object","required":["street","city","state","zipcode"]}]}},"required":["property"]},"id":"schema_26"},"schema_27":{"kind":"json-schema","data":{"type":"object","properties":{"Location":{"type":"string","description":"URL of the existing property."}}},"id":"schema_27"},"schema_28":{"kind":"json-schema","data":{"type":"object","properties":{"Location":{"type":"string","description":"URL of the newly created property."}}},"id":"schema_28"},"schema_29":{"kind":"json-schema","data":{"type":"object","properties":{"applicant":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identity fields for the applicant. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"first_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last_name"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"are preferred; legacy clients may still send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"full_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Do not send both name forms. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is always required. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"phone_number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is optional. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dob"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ssn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are also"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"optional at create time — if not supplied here, the applicant"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"will be prompted to provide them via the consent flow on their"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"first order. Values must match the applicant's legal identity."},"children":[]}]}]}],"allOf":[{"type":"object","properties":{"email":{"type":"string","format":"email","description":"Email address used to contact the applicant about their screening.","example":"jane@example.com"},"dob":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date of birth in ISO-8601 format ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"1990-05-14"},"phone_number":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mobile phone number to contact the applicant about their"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"screening. US numbers only. Accepted in any common format"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"(415) 555-0100"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"415-555-0100"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+14155550100"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":");"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"normalized to E.164 before storage."},"children":[]}]}]}],"example":"415-555-0100"},"ssn":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applicant's full 9-digit US Social Security Number. Accepted with or without dashes ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"123-45-6789"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"123456789"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Subsequent reads only return a masked form."},"children":[]}]}]}],"example":"123-45-6789"}},"required":["email"],"oneOf":[{"title":"Split applicant name","type":"object","properties":{"first_name":{"type":"string","minLength":1,"maxLength":50,"description":"Applicant's given name.","example":"Jane"},"last_name":{"type":"string","minLength":1,"maxLength":50,"description":"Applicant's family name.","example":"Doe"}},"required":["first_name","last_name"],"not":{"properties":{"full_name":{}},"required":["full_name"]}},{"title":"Legacy full applicant name","type":"object","properties":{"full_name":{"type":"string","minLength":2,"maxLength":100,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Legacy alternative to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"first_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"first_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; when split on the first whitespace, it must produce at least two name parts and each resulting part must be 1 to 50 characters."},"children":[]}]}]}],"example":"Jane Doe"}},"required":["full_name"],"not":{"anyOf":[{"properties":{"first_name":{}},"required":["first_name"]},{"properties":{"last_name":{}},"required":["last_name"]}]}}]}]}},"required":["applicant"]},"id":"schema_29"},"schema_30":{"kind":"json-schema","data":{"type":"string","example":"t=1714414933,v1=8d2bf3ac0f9e1b2d4c5a6e7f8091a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9"},"id":"schema_30"},"schema_31":{"kind":"json-schema","data":{"type":"string","enum":["CheckrTenant/1"]},"id":"schema_31"}},"exampleStore":{},"securitySchemeStore":{"bearer-token":{"id":"bearer-token","type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key issued to your organization. Send it as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"servers":[{"url":"https://tenant.checkr.com/api","description":"Checkr Tenant API"}]},"options":{"schemasExpansionLevel":2,"showExtensions":true,"hideSidebar":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/v1.json?download"},{"url":"/_bundle/v1.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Checkr Tenant API","description":"The Checkr Tenant API lets property managers and landlords order tenant\nscreenings, manage rental properties, and retrieve screening reports\nprogrammatically. It is organized around four core resources:\n\n- **Properties** — rental addresses you screen applicants for.\n- **Applicants** — people being screened.\n- **Orders** — a screening request placed for an applicant against a property.\n- **Reports** — the results returned by an order, broken down by check type.\n\nReports are produced asynchronously. You can either listen for `report.*`\n[webhooks](webhooks.md) or poll `GET /orders/{id}/report`. All resources are\nisolated per environment via test and live API keys — see the\n[Testing guide](testing.md) for how mode isolation works and which scenarios\nare available against test keys.\n\nNew to the API? Start with the [Getting Started guide](index.md) for the\nend-to-end walkthrough, including authorization, billing setup, and your first\norder.\n","summary":"The Tenant Monolith API is a RESTful service that powers tenant screening\nworkflows at Checkr. It uses resource-oriented URLs, supports HTTPS for\nauthentication and requests, and returns JSON responses.\n"}},"baseSlug":"/v1","routesMapping":{}}