{"openapi":"3.0.0","paths":{"/user/whoami":{"get":{"description":"Return the authenticated user's information for legacy vID clients.\n\n**Behavior**\n\n- Each organization's CRA relations include only the CRA's public fields: id, name, shortName, contactEmail, contactPhone, website and hexColor.","operationId":"whoAmI","parameters":[],"responses":{"200":{"description":"The authenticated user, including its organizations.","content":{"application/json":{"schema":{"type":"object"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"403":{"description":"The request has no authenticated user, for example because no API key was sent. The body is the NestJS error body, not the name/code error shape.","content":{"application/json":{"schema":{"type":"object","required":["statusCode","message","error"],"properties":{"statusCode":{"type":"integer","enum":[403]},"message":{"type":"string"},"error":{"type":"string"}}},"examples":{"noApiKey":{"summary":"No API key","value":{"message":"Unauthorized","error":"Forbidden","statusCode":403}}}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"security":[{"apiKey":[]}],"summary":"Get Current User","tags":["User"]}},"/v1/beam":{"post":{"description":"Create a new beam configuration for processing credentials.\n\n**Behavior**\n\n- The beam belongs to the caller's active organization.\n\n**Related:** [Create Beam Input Type](/reference/createbeaminputtype-1) · [Create Credential Type](/reference/createcredentialtype-1) · [Working with Beams](/docs/working-with-beams)","operationId":"createBeam","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBeamRequest"}}}},"responses":{"201":{"description":"Beam created. Retain `beamId` to add input types and credential types.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBeamResponse"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"security":[{"apiKey":[]}],"summary":"Create Beam","tags":["Beam"]}},"/v1/beam-input-type":{"post":{"description":"Register a new beam input type definition for a beam.\n\n**Behavior**\n\n- The slug is generated from the beam name and the version is `1.0.0`.\n\n**Related:** [Get Beam](/reference/getbeam-1) · [Create Credential](/reference/createcredential-1)","operationId":"createBeamInputType","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBeamInputTypeRequest"}}}},"responses":{"201":{"description":"Beam input type created; returns its ID and generated slug.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBeamInputTypeResponse"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"`schema` is not a valid JSON Schema (`Invalid schema`), or `beamId` does not identify a beam visible to the caller (`Beam not found`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"security":[{"apiKey":[]}],"summary":"Create Beam Input Type","tags":["Beam Input Type"]}},"/v1/beam-input-type/{id}":{"get":{"description":"Retrieve an existing beam input type definition by ID.\n\n**Behavior**\n\n- An unknown or inaccessible ID is not reported as 404: the handler returns null, so the 200 response carries no beam input type object.","operationId":"getBeamInputType","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"The beam input type with its parent beam.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBeamInputTypeResponse"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"security":[{"apiKey":[]}],"summary":"Get Beam Input Type","tags":["Beam Input Type"]}},"/v1/beam/{id}":{"get":{"description":"Retrieve a beam configuration and its related types by ID.\n\n**Behavior**\n\n- An unknown or inaccessible ID is not reported as 404: the handler returns null, so the 200 response carries no beam object.","operationId":"getBeam","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"The beam with its input types and credential types.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBeamResponse"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"security":[{"apiKey":[]}],"summary":"Get Beam","tags":["Beam"]}},"/v1/credential":{"post":{"description":"Create a new W3C verifiable credential for a user's submitted input.\n\n**Behavior**\n\n- After storing the input, the handler checks five times at 100 ms intervals for a credential created from it, then responds.\n- `input` is not validated against the beam input type's schema by this handler.\n\n**Related:** [Get Credential](/reference/getcredential-1) · [Get Credential Status](/reference/getcredentialstatus)","operationId":"createCredential","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCredentialRequest"}}}},"responses":{"200":{"description":"Beam input recorded. `credentialId` is the credential produced from it, or null if none existed when the handler stopped waiting.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCredentialResponse"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"500":{"description":"Unexpected server error, including when `inputTypeId` does not identify a beam input type visible to the caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"security":[{"apiKey":[]}],"summary":"Create Credential","tags":["Credential"]}},"/v1/credential-type":{"post":{"description":"Create a credential type schema that can be issued by a beam.\n\n**Behavior**\n\n- The slug is generated from the beam name and the version is `1.0.0`.\n\n**Related:** [Get Credential Type](/reference/getcredentialtype-1)","operationId":"createCredentialType","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCredentialTypeRequest"}}}},"responses":{"201":{"description":"Credential type created; returns its ID and generated slug.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCredentialTypeResponse"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"`schema` is not a valid JSON Schema (`Invalid schema`), or `beamId` does not identify a beam visible to the caller (`Beam not found`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"security":[{"apiKey":[]}],"summary":"Create Credential Type","tags":["Credential Type"]}},"/v1/credential-type/{id}":{"get":{"description":"Retrieve a credential type definition by ID.\n\n**Behavior**\n\n- An unknown or inaccessible ID is not reported as 404: the handler returns null, so the 200 response carries no credential type object.","operationId":"getCredentialType","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"The credential type with its parent beam.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCredentialTypeResponse"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"security":[{"apiKey":[]}],"summary":"Get Credential Type","tags":["Credential Type"]}},"/v1/credential/status/{id}":{"get":{"description":"Fetch the issuance status for a specific credential by ID.","operationId":"getCredentialStatus","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"The credential's status value.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CredentialStatusResponse"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"404":{"description":"No status exists for this credential ID (`Credential not found`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"security":[{"apiKey":[]}],"summary":"Get Credential Status","tags":["Credential"]}},"/v1/credential/{id}":{"get":{"description":"Retrieve a credential and its metadata by credential ID.","operationId":"getCredential","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"The credential with its data and status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCredentialResponse"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"404":{"description":"The credential does not exist or is not visible to the caller (`Credential not found`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"security":[{"apiKey":[]}],"summary":"Get Credential","tags":["Credential"]}},"/v1/disputes":{"post":{"description":"Submit a dispute for a specific order.\n\n**Behavior**\n\n- The consumer's name, email, phone, date of birth and last four SSN digits are copied from the order's applicant data when the dispute is submitted.\n\n**Related:** [Get Dispute Details](/reference/getdispute) · [Update Dispute Status](/reference/updatedisputestatus) · [Dispute Management API](/docs/dispute-management-api)","operationId":"submitDispute","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitDisputeRequest"},"examples":{"minimal":{"summary":"Minimal dispute","value":{"orderId":"0bb0f6f8-459f-482a-952e-7caf029517f6","reason":"INACCURATE_RECORDS"}},"detailed":{"summary":"Dispute with details","value":{"orderId":"0bb0f6f8-459f-482a-952e-7caf029517f6","reason":"INACCURATE_RECORDS","specificItem":"Criminal record from 2015 in Alameda County","description":"The record belongs to a different person."}}}}}},"responses":{"201":{"description":"Dispute created. Retain `disputeId` to read or update it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitDisputeResponse"},"examples":{"created":{"summary":"Dispute opened","value":{"disputeId":"9d3e5f7a-8b2c-4a1e-9f6d-7c8b5a4e3d2f","status":"OPEN","createdAt":"2026-11-05T09:12:00.000Z"}}}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"404":{"description":"`orderId` does not identify an order visible to the caller (`Order <id> doesn't exist`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"security":[{"apiKey":[]}],"summary":"Submit Dispute","tags":["Dispute"]}},"/v1/disputes/order/{orderId}":{"get":{"description":"Retrieve all disputes associated with a specific order ID.","operationId":"getDisputesByOrder","parameters":[{"name":"orderId","required":true,"in":"path","description":"The ID of the order","schema":{"type":"string"}}],"responses":{"200":{"description":"The disputes submitted for the order.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisputeListResponse"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"404":{"description":"The order does not exist or is not visible to the caller (`Order <id> doesn't exist`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"security":[{"apiKey":[]}],"summary":"List Disputes by Order","tags":["Dispute"]}},"/v1/disputes/{id}":{"get":{"description":"Retrieve detailed information about a specific dispute by its ID.","operationId":"getDispute","parameters":[{"name":"id","required":true,"in":"path","description":"The ID of the dispute","schema":{"type":"string"}}],"responses":{"200":{"description":"The dispute, including the consumer details copied at submission.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisputeDetails"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"404":{"description":"The dispute does not exist or is not visible to the caller (`Dispute <id> doesn't exist`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"security":[{"apiKey":[]}],"summary":"Get Dispute Details","tags":["Dispute"]}},"/v1/disputes/{id}/status":{"patch":{"description":"Update the status of an existing dispute.\n\n**Behavior**\n\n- `resolutionOutcome` is stored only when `status` is RESOLVED; any other status sets it to null.","operationId":"updateDisputeStatus","parameters":[{"name":"id","required":true,"in":"path","description":"The ID of the dispute","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDisputeStatusRequest"}}}},"responses":{"200":{"description":"The dispute's new status, resolution outcome and update time.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDisputeStatusResponse"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"404":{"description":"The dispute does not exist or is not visible to the caller (`Dispute <id> doesn't exist`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"security":[{"apiKey":[]}],"summary":"Update Dispute Status","tags":["Dispute"]}},"/v1/file":{"post":{"description":"Upload one file for the authenticated user as `multipart/form-data` with a single file part named `file`.\nNo other form fields are required; additional text fields are not used. The file may be at most 10 MiB (10,485,760 bytes); a larger file returns 413.\nA part with another field name returns 400.\n\nThe stored media type is the `Content-Type` sent with the file part (not detected from content), and the stored name is its filename.\nHEIC/HEIF images, detected from their content, are converted to JPEG and renamed `.jpg`; an undecodable HEIC/HEIF file returns 500 and stores nothing.\n\nRetain `id`: it is the file ID used elsewhere (for example `selfieFileId`) and by Get File.\n\n```sh\ncurl -X POST \"$CEREBRUM_BASE_URL/v1/file\" \\\n  -H \"apikey: $CEREBRUM_API_KEY\" \\\n  -F \"file=@selfie.jpg;type=image/jpeg\"\n```\n\n**Related:** [Get File](/reference/getfile)","operationId":"uploadFile","parameters":[],"responses":{"201":{"description":"File stored.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileUploadResponse"},"examples":{"uploaded":{"summary":"File stored","value":{"id":"1d3f5b7a-9c2e-4b6d-8a1f-3e5c7a9b1d42","key":"cortex/uploads/1d3f5b7a-9c2e-4b6d-8a1f-3e5c7a9b1d42_selfie.jpg"}}}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"413":{"description":"The file is larger than 10 MiB (10,485,760 bytes).","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"integer"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"example":{"statusCode":413,"message":"File too large","error":"Payload Too Large"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"security":[{"apiKey":[]}],"summary":"Upload File","tags":["File"],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","required":["file"],"properties":{"file":{"type":"string","format":"binary","description":"The file to store (maximum 10,485,760 bytes). Send its media type as the part Content-Type."}}}}}}}},"/v1/file/{id}":{"get":{"description":"Download a stored file. The response body is the file bytes, not JSON. There is no redirect.\n\n`Content-Type` is the media type recorded at upload, or `application/octet-stream` when none was recorded.\n`Content-Disposition` is `inline` for JPEG, PNG, GIF, WebP and SVG images and `attachment` otherwise, with the stored filename.\nThe response may be compressed with `Content-Encoding: gzip` when the client accepts it; HTTP clients decode this automatically.\n\nA missing file, a file the caller cannot access, and a storage read failure all return 404.\n\n```sh\ncurl -f \"$CEREBRUM_BASE_URL/v1/file/$FILE_ID\" \\\n  -H \"apikey: $CEREBRUM_API_KEY\" \\\n  -o downloaded-file\n```","operationId":"getFile","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"The file bytes.","headers":{"Content-Type":{"description":"Stored media type, or application/octet-stream.","schema":{"type":"string","example":"image/jpeg"}},"Content-Disposition":{"description":"inline for common image types, attachment otherwise.","schema":{"type":"string","example":"inline; filename=\"selfie.jpg\""}},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}},"image/jpeg":{"schema":{"type":"string","format":"binary"}},"image/png":{"schema":{"type":"string","format":"binary"}},"application/pdf":{"schema":{"type":"string","format":"binary"}},"*/*":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"404":{"description":"The file does not exist, is not visible to the caller, or could not be read.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"security":[{"apiKey":[]}],"summary":"Get File","tags":["File"]}},"/v1/monitoring/enrollments/{orderId}/disenroll":{"post":{"description":"Request disenrollment for an existing monitoring enrollment by orderId.\n\n**Behavior**\n\n- Applies to the order's most recent enrollment that is not already DISENROLLMENT_PENDING or DISENROLLED. `source` defaults to CLIENT_REQUEST.\n\n**Related:** [Request Monitoring Enrollment](/reference/requestenrollment)","operationId":"requestDisenrollment","parameters":[{"name":"orderId","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestMonitoringDisenrollmentRequest"}}}},"responses":{"200":{"description":"The order ID and the ID of the enrollment whose disenrollment was requested.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestMonitoringDisenrollmentResponse"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"The order has no enrollment eligible for disenrollment, or the order is not visible to the caller (`No eligible monitoring enrollment found for this orderId`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"security":[{"apiKey":[]}],"summary":"Request Monitoring Disenrollment","tags":["Monitoring"]}},"/v1/monitoring/enrollments/{orderId}/enroll":{"post":{"description":"Request enrollment for monitoring by orderId. Returns existing enrollment when already enrolled.\n\n**Behavior**\n\n- Reuse: if the order already has an enrollment for its package's monitoring configuration that is not DISENROLLED, that enrollment's ID is returned with message `Monitoring enrollment already exists for this orderId` and nothing new is created. Otherwise a new enrollment is created and the message is `Monitoring enrollment created for this orderId`.\n- The monitoring configuration is the one attached to the order's package (the most recently created package when several are attached).\n\n**Related:** [Request Monitoring Disenrollment](/reference/requestdisenrollment) · [List Monitoring Reports by Order](/reference/listreportsbyorder) · [Event Types](/docs/event-types)","operationId":"requestEnrollment","parameters":[{"name":"orderId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"The order ID, the enrollment ID, and a message saying whether the enrollment was created or already existed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestMonitoringEnrollmentResponse"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"The message is a reason code: `ORDER_NOT_FOUND` (the order does not exist or is not visible), `ORDER_NO_ORGANIZATION`, `ORDER_NO_PACKAGE_SET`, `NO_CONFIG` (the package has no monitoring configuration), `CONFIGURATION_INELIGIBLE_OR_SKIPPED` (the configuration has expired or skipped this order) or `MONITORING_CONFIGURATION_INVALID`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"security":[{"apiKey":[]}],"summary":"Request Monitoring Enrollment","tags":["Monitoring"]}},"/v1/monitoring/orders/{orderId}/reports":{"get":{"description":"Return monitoring reports with an available PDF for an order. Reports without an attached PDF, including clean/no-hit monitoring cycles, are not returned.\n\n**Behavior**\n\n- `data` is an empty array until a report with an active PDF exists. Use Get Monitoring Report to read a report that has no PDF.\n\n**Related:** [Get Monitoring Report](/reference/getreport) · [Event Types](/docs/event-types)","operationId":"listReportsByOrder","parameters":[{"name":"orderId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Monitoring reports for the order that have a PDF, newest first, each with a signed `pdfUrl`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitoringReportListResponse"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"404":{"description":"The order does not exist or is not visible to the caller (`ORDER_NOT_FOUND`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"security":[{"apiKey":[]}],"summary":"List Monitoring Reports by Order","tags":["Monitoring"]}},"/v1/monitoring/reports/{reportId}":{"get":{"description":"Retrieve monitoring report details and a signed URL for its latest PDF.\n\n**Behavior**\n\n- Unlike List Monitoring Reports by Order, this returns reports that have no PDF.\n\n**Related:** [List Monitoring Reports by Order](/reference/listreportsbyorder)","operationId":"getReport","parameters":[{"name":"reportId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"The monitoring report with a signed URL for its latest PDF; `pdfUrl` is null when it has none.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitoringReportDetailResponse"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"404":{"description":"The report does not exist or is not visible to the caller (`MONITORING_REPORT_NOT_FOUND`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"security":[{"apiKey":[]}],"summary":"Get Monitoring Report","tags":["Monitoring"]}},"/v1/orders":{"post":{"description":"Submit applicant information to create a standard order for a package.\n\n**Behavior**\n\n- The order's organization is `organizationId`, otherwise the package's owner, otherwise the caller's active organization. It must be one of the caller's own organizations.\n\n**Related:** [Get Order Details](/reference/getorder-1) · [Standard Order API](/docs/cortex-api) · [Webhooks](/docs/webhook-guides)","operationId":"createStandardOrder","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandardOrderRequest"}}}},"responses":{"201":{"description":"Order created with status PENDING. Retain `orderId`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandardOrderResponse"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Request validation failed (for example `packageId` missing, `additionalMetadata` not an object, `postbackWebhookUrl` not an absolute HTTPS URL, or empty `applicantData`); `packageId` does not identify a package visible to the caller (`packageId is invalid`); or a name has `middleName` without `hasMiddleName: true`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"403":{"description":"The resolved organization is not one of the caller's organizations (`organizationId is not accessible`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"security":[{"apiKey":[]}],"summary":"Create Standard Order","tags":["Order"]},"get":{"description":"Retrieve orders for all organizations the authenticated user can access, with optional filters.\n\n**Related:** [Get Order Details](/reference/getorder-1)","operationId":"getAllOrders","parameters":[{"name":"expand","required":false,"in":"query","description":"Related data to include. Repeat the parameter for several values, for example `?expand=reportable_results&expand=vid_report` (`expand[]=` is also accepted). Comma-separated values are not split. Unknown values are ignored. `idVerificationData` is a legacy alias of `id_verification_data`.","schema":{"type":"array","items":{"type":"string","enum":["id_verification_data","idVerificationData","reportable_results","background_report_pdf","signed_disclosure","vid_report","verification_check_results","credentials","selfie","ip_address_details"]}},"style":"form","explode":true,"example":["reportable_results","vid_report"]},{"name":"metadata","required":false,"in":"query","description":"URL-encoded JSON object used to filter additionalMetadata by JSON containment. Example filter: {\"user\":{\"userId\":\"YC3GXWJ55FJ\"}} matches metadata like {\"user\":{\"firstName\":\"john\",\"lastName\":\"doe\",\"userId\":\"YC3GXWJ55FJ\"},\"session\":{\"id\":\"HHROE63HX4K\",\"createdAt\":\"2026-02-11T01:12:47Z\"}}.","schema":{"example":"{\"user\":{\"userId\":\"YC3GXWJ55FJ\"}}","type":"string"}},{"name":"limit","required":false,"in":"query","description":"Number of orders per page. Defaults to 10. Maximum allowed value is 30.","schema":{"type":"integer","minimum":1,"maximum":30}},{"name":"offset","required":false,"in":"query","description":"Number of records to skip. Defaults to 0.","schema":{"type":"integer","minimum":0}},{"name":"packageId","required":false,"in":"query","description":"Filter orders by package ID","schema":{"type":"string"}},{"name":"status","required":false,"in":"query","description":"Filter orders by status","schema":{"enum":["PENDING","IN_PROGRESS","IN_DISPUTE","COMPLETE","INCOMPLETE"],"type":"string"}}],"responses":{"200":{"description":"One page of orders visible to the caller, with pagination metadata and links.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrdersResponse"},"examples":{"firstPage":{"summary":"Orders for one package, single page","description":"GET /v1/orders?packageId={package id}. Filters stay in every pagination link.","value":{"data":[{"id":"0bb0f6f8-459f-482a-952e-7caf029517f6","applicantContactDetails":{"email":"applicant@example.com","phoneNumber":""},"backgroundReportUrl":"https://cognition.cerebrum.com/user/e4b7d1c3-9a2f-4f6e-8d1b-3c5a7e9f2b64?tab=Documents","reportDisputeUrl":"https://cognition.cerebrum.com/dispute/northwind-staffing/auth/0bb0f6f8-459f-482a-952e-7caf029517f6?email=applicant%40example.com","additionalMetadata":{"clientReferenceId":"APP-1042"},"status":"COMPLETE","score":"ID_VERIFIED","customScore":null,"orderDeliveryType":"vIDWeb","alert":"NO_ALERTS_FOUND","createdAt":"2026-11-03T16:20:00.000Z","updatedAt":"2026-11-03T16:27:41.000Z","reportCompletedAt":"2026-11-03T16:27:41.000Z"}],"meta":{"limit":10,"offset":0,"total":1},"links":{"self":"/v1/orders?packageId=81eb7401-8ff0-4404-8450-4d7508482c19&limit=10&offset=0","next":null,"prev":null}}},"middlePage":{"summary":"Middle page of completed orders","description":"GET /v1/orders?status=COMPLETE&limit=2&offset=2","value":{"data":[{"id":"0bb0f6f8-459f-482a-952e-7caf029517f6","applicantContactDetails":{"email":"applicant@example.com","phoneNumber":""},"backgroundReportUrl":"https://cognition.cerebrum.com/user/e4b7d1c3-9a2f-4f6e-8d1b-3c5a7e9f2b64?tab=Documents","reportDisputeUrl":"https://cognition.cerebrum.com/dispute/northwind-staffing/auth/0bb0f6f8-459f-482a-952e-7caf029517f6?email=applicant%40example.com","additionalMetadata":{"clientReferenceId":"APP-1042"},"status":"COMPLETE","score":"ID_VERIFIED","customScore":null,"orderDeliveryType":"vIDWeb","alert":"NO_ALERTS_FOUND","createdAt":"2026-11-03T16:20:00.000Z","updatedAt":"2026-11-03T16:27:41.000Z","reportCompletedAt":"2026-11-03T16:27:41.000Z"},{"id":"3c9e1a5b-7d2f-4e8a-b6c4-1f3d5a7c9e20","applicantContactDetails":{"email":"applicant@example.com","phoneNumber":""},"backgroundReportUrl":"https://cognition.cerebrum.com/user/e4b7d1c3-9a2f-4f6e-8d1b-3c5a7e9f2b64?tab=Documents","reportDisputeUrl":"https://cognition.cerebrum.com/dispute/northwind-staffing/auth/3c9e1a5b-7d2f-4e8a-b6c4-1f3d5a7c9e20?email=applicant%40example.com","additionalMetadata":{"clientReferenceId":"APP-1043"},"status":"COMPLETE","score":"REVIEW_PASS","customScore":null,"orderDeliveryType":"vIDWeb","alert":"ALERTS_FOUND","createdAt":"2026-11-02T11:05:00.000Z","updatedAt":"2026-11-02T11:31:09.000Z","reportCompletedAt":"2026-11-02T11:31:09.000Z"}],"meta":{"limit":2,"offset":2,"total":5},"links":{"self":"/v1/orders?status=COMPLETE&limit=2&offset=2","next":"/v1/orders?status=COMPLETE&limit=2&offset=4","prev":"/v1/orders?status=COMPLETE&limit=2&offset=0"}}},"lastPage":{"summary":"Last page","description":"GET /v1/orders?status=COMPLETE&limit=2&offset=4","value":{"data":[{"id":"7a2c4e6b-9d1f-4a3c-8e5b-2d4f6a8c0e31","applicantContactDetails":{"email":"applicant@example.com","phoneNumber":""},"backgroundReportUrl":"https://cognition.cerebrum.com/user/e4b7d1c3-9a2f-4f6e-8d1b-3c5a7e9f2b64?tab=Documents","reportDisputeUrl":"https://cognition.cerebrum.com/dispute/northwind-staffing/auth/7a2c4e6b-9d1f-4a3c-8e5b-2d4f6a8c0e31?email=applicant%40example.com","additionalMetadata":{"clientReferenceId":"APP-1039"},"status":"COMPLETE","score":"ID_VERIFIED","customScore":null,"orderDeliveryType":"vIDWeb","alert":"NO_ALERTS_FOUND","createdAt":"2026-10-30T08:45:00.000Z","updatedAt":"2026-10-30T09:02:17.000Z","reportCompletedAt":"2026-10-30T09:02:17.000Z"}],"meta":{"limit":2,"offset":4,"total":5},"links":{"self":"/v1/orders?status=COMPLETE&limit=2&offset=4","next":null,"prev":"/v1/orders?status=COMPLETE&limit=2&offset=2"}}},"empty":{"summary":"No matching orders","description":"GET /v1/orders?status=IN_DISPUTE","value":{"data":[],"meta":{"limit":10,"offset":0,"total":0},"links":{"self":"/v1/orders?status=IN_DISPUTE&limit=10&offset=0","next":null,"prev":null}}}}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"`limit` is not an integer from 1 to 30, `offset` is not a non-negative integer, or `status` is not an order status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"security":[{"apiKey":[]}],"summary":"List Orders","tags":["Order"]}},"/v1/orders/simulate-webhook":{"post":{"description":"Trigger a simulated webhook to a provided URL with a specified event type.\n\n**Behavior**\n\n- The notification is queued for the caller's active organization with `postbackWebhookUrl` as its postback URL, to run about one second later with up to five attempts. The handler does not look up `id`.\n- `event` selects the event type, for example ORDER_STATUS_CHANGE as order.updated, VOUCHER_CANCELED as voucher.canceled and MONITORING_REPORT_GENERATED as monitoring.report.generated. When `event` is omitted, ORDER_STATUS_CHANGE (order.updated) is sent.\n\n**Related:** [Using Simulated Webhook](/docs/using-simulated-api-responses) · [Event Types](/docs/event-types)","operationId":"simulateWebhook","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SimulateWebhookRequest"}}}},"responses":{"201":{"description":"Simulated notification queued (`success: true`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Request validation failed: `id` is not a string, `event` is not one of the listed events, `postbackWebhookUrl` is not an absolute HTTPS URL (`postbackWebhookUrl must use HTTPS protocol`), or `additionalMetadata` is not an object. Also returned when the request has no active organization (`missing active organization in request`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"security":[{"apiKey":[]}],"summary":"Simulate Webhook","tags":["Order"]}},"/v1/orders/{id}":{"patch":{"description":"Partially update an order's status, score, and custom score. At least one field is required.\n\n**Behavior**\n\n- Only the fields present in the request change. `customScore: null` clears the custom score.\n\n**Related:** [Score, Status and Alert](/docs/score-status-and-alert)","operationId":"updateOrder","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateOrderRequest"}}}},"responses":{"200":{"description":"The order's ID, status, score and custom score after the update.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateOrderResponse"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"The request must include at least one of status, score, or customScore, and every supplied value must be valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"404":{"description":"The order does not exist or is not visible to the caller (`order <id> doesn't exist`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"security":[{"apiKey":[]}],"summary":"Update Order","tags":["Order"]},"get":{"description":"Retrieve a single order with optional expanded related data.\n\n**Related:** [Order](/docs/order) · [Score, Status and Alert](/docs/score-status-and-alert)","operationId":"getOrder","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"expand","required":false,"in":"query","description":"Related data to include. Repeat the parameter for several values, for example `?expand=reportable_results&expand=vid_report` (`expand[]=` is also accepted). Comma-separated values are not split. Unknown values are ignored. `idVerificationData` is a legacy alias of `id_verification_data`.","schema":{"type":"array","items":{"type":"string","enum":["id_verification_data","idVerificationData","reportable_results","background_report_pdf","signed_disclosure","vid_report","verification_check_results","credentials","selfie","ip_address_details"]}},"style":"form","explode":true,"example":["reportable_results","vid_report"]}],"responses":{"200":{"description":"The order. Expanded fields are included only when requested with `expand`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"},"examples":{"pending":{"summary":"Pending order","value":{"id":"0bb0f6f8-459f-482a-952e-7caf029517f6","applicantContactDetails":{"email":"applicant@example.com","phoneNumber":""},"backgroundReportUrl":"https://cognition.cerebrum.com/user/e4b7d1c3-9a2f-4f6e-8d1b-3c5a7e9f2b64?tab=Documents","reportDisputeUrl":"https://cognition.cerebrum.com/dispute/northwind-staffing/auth/0bb0f6f8-459f-482a-952e-7caf029517f6?email=applicant%40example.com","additionalMetadata":{"clientReferenceId":"APP-1042"},"status":"PENDING","score":null,"customScore":null,"orderDeliveryType":"vIDWeb","alert":null,"createdAt":"2026-11-03T16:20:00.000Z","updatedAt":"2026-11-03T16:20:00.000Z","reportCompletedAt":null}},"complete":{"summary":"Completed order","value":{"id":"0bb0f6f8-459f-482a-952e-7caf029517f6","applicantContactDetails":{"email":"applicant@example.com","phoneNumber":""},"backgroundReportUrl":"https://cognition.cerebrum.com/user/e4b7d1c3-9a2f-4f6e-8d1b-3c5a7e9f2b64?tab=Documents","reportDisputeUrl":"https://cognition.cerebrum.com/dispute/northwind-staffing/auth/0bb0f6f8-459f-482a-952e-7caf029517f6?email=applicant%40example.com","additionalMetadata":{"clientReferenceId":"APP-1042"},"status":"COMPLETE","score":"ID_VERIFIED","customScore":null,"orderDeliveryType":"vIDWeb","alert":"NO_ALERTS_FOUND","createdAt":"2026-11-03T16:20:00.000Z","updatedAt":"2026-11-03T16:27:41.000Z","reportCompletedAt":"2026-11-03T16:27:41.000Z"}}}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"404":{"description":"The order does not exist or is not visible to the caller (`order <id> doesn't exist`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"security":[{"apiKey":[]}],"summary":"Get Order Details","tags":["Order"]}},"/v1/orders/{id}/applicant-data":{"get":{"operationId":"getOrderApplicantData","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"The applicant's names, addresses, SSN, date of birth and contact details recorded on the order.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderApplicantDataResponse"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"404":{"description":"The order does not exist or is not visible to the caller, or it has no applicant data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"security":[{"apiKey":[]}],"summary":"Get the applicant data for an order","tags":["Order"],"description":"**Behavior**\n\n- `socialSecurityNumber` is `xxx-xx-xxxx` unless the caller has the SUPER_ADMIN, INTEGRATION_ADMIN, CRA_ADMIN or PROCESSOR role or is the applicant. When no SSN was recorded it is `000-00-0000`."}},"/v1/orders/{orderId}/adverse-action":{"post":{"description":"Webhook endpoint to send an adverse action notice for a given order.\n\n**Behavior**\n\n- The notice is sent by a background job after this response.","operationId":"sendAdverseActionNotice","parameters":[{"name":"orderId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Adverse action notice queued (`success: true`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendAdverseActionNoticeResponse"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"The order does not exist or is not visible to the caller (`Order <id> not found`). This case returns 400, not 404.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"security":[{"apiKey":[]}],"summary":"Send Adverse Action Notice","tags":["Order"]}},"/v1/orders/{orderId}/check-ssn":{"get":{"description":"Check whether the applicant on an order supplied a Social Security number. No API key is required. Returns 404 when the order does not exist.","operationId":"checkOrderForSSN","parameters":[{"name":"orderId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Whether the applicant supplied an SSN. A placeholder SSN counts as none.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckOrderForSSNResponse"},"examples":{"hasSsn":{"summary":"The applicant supplied an SSN","value":{"hasSsn":true}}}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"404":{"description":"Order not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"security":[],"summary":"Check Order Has SSN","tags":["Order"]}},"/v1/orders/{orderId}/reportable-results":{"post":{"description":"Generate reportable results for the specified order.\n\n**Related:** [Get Order Details](/reference/getorder-1)","operationId":"createReportableResults","parameters":[{"name":"orderId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"201":{"description":"Reportable results generated for the order (`success: true`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"404":{"description":"The order does not exist or is not visible to the caller.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"security":[{"apiKey":[]}],"summary":"Create Reportable Results","tags":["Order"]}},"/v1/orders/{orderId}/score":{"patch":{"description":"Update an order's score and optional custom score value.\n\n**Behavior**\n\n- `customScore` changes only when the field is present; null clears it.\n\n**Related:** [Update Order](/reference/updateorder) · [Score, Status and Alert](/docs/score-status-and-alert)","operationId":"updateOrderScore","parameters":[{"name":"orderId","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateOrderScoreRequest"}}}},"responses":{"200":{"description":"The order's ID, score and custom score after the update.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateOrderScoreResponse"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"404":{"description":"The order does not exist or is not visible to the caller (`order <id> doesn't exist`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"security":[{"apiKey":[]}],"summary":"Update Order Score","tags":["Order"]}},"/v1/orders/{orderId}/searches":{"post":{"description":"Attach a requested search to an existing order.\n\n**Behavior**\n\n- Adding a search to a COMPLETE order sets the order's status back to PENDING; the score is not changed.\n- The search uses the order's existing SSN record. If one exists, an SSN supplied in search data is discarded and does not replace it. Standard orders always have an SSN record, including a placeholder when hasSSN is false. A new encrypted SSN record is created only when the order has none.\n\n**Related:** [Get Order Search](/reference/getordersearch) · [Adding Searches to Orders](/docs/adding-searches-to-orders)","operationId":"createRequestedSearchForOrder","parameters":[{"name":"orderId","required":true,"in":"path","description":"The ID of the order","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRequestedSearchRequest"},"examples":{"natCrim":{"summary":"National criminal search","value":{"searchType":"nat+crim","data":{"firstName":"Jordan","middleName":"A","lastName":"Lee","dateOfBirth":"1990-04-12","ssn":"123-45-6789"}}},"countyByFips":{"summary":"County search by FIPS code","value":{"searchType":"county","data":{"firstName":"Jordan","middleName":"A","lastName":"Lee","dateOfBirth":"1990-04-12","ssn":"123-45-6789","address":{"fipsCode":"06001"}}}},"countyByName":{"summary":"County search by county and state","value":{"searchType":"county","data":{"firstName":"Jordan","middleName":"A","lastName":"Lee","dateOfBirth":"1990-04-12","ssn":"123-45-6789","address":{"county":"Alameda County","state":"CA"}}}},"ssn":{"summary":"SSN trace","value":{"searchType":"ssn","data":{"firstName":"Jordan","middleName":"A","lastName":"Lee","dateOfBirth":"1990-04-12","ssn":"123-45-6789"}}},"fastTrack":{"summary":"Fast-track national criminal search","value":{"searchType":"fastTrack","data":{"firstName":"Jordan","middleName":"A","lastName":"Lee","dateOfBirth":"1990-04-12","ssn":"123-45-6789"}}},"aamva":{"summary":"AAMVA driver licence check","value":{"searchType":"aamva","data":{"firstName":"Jordan","lastName":"Lee","dateOfBirth":"1990-04-12","licenseNumber":"D1234567","licenseState":"CA"}}},"identityRecheck":{"summary":"Identity re-check with a new selfie","description":"`selfieFileId` is the `id` returned by Upload File.","value":{"searchType":"identityRecheck","data":{"selfieFileId":"1d3f5b7a-9c2e-4b6d-8a1f-3e5c7a9b1d42"}}},"standardIdVerification":{"summary":"Standard ID verification (no data)","value":{"searchType":"standardIdVerification"}},"tazworks":{"summary":"TazWorks search","value":{"searchType":"tazworks","data":{"firstName":"Jordan","lastName":"Lee","dateOfBirth":"1990-04-12","address":{"addressLineOne":"100 Example Street","city":"Oakland","state":"CA","postalCode":"94607","country":"US"}}}}}}}},"responses":{"201":{"description":"Search added. Retain `id` to read it with Get Order Search.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRequestedSearchResponse"},"examples":{"created":{"summary":"Search requested","value":{"id":"5e7a9c1b-3d5f-4a2c-9e6b-8d0f2a4c6e75"}}}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Invalid request payload. For county searches, an invalid FIPS code returns a known error code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"example":{"name":"BAD_REQUEST_ERROR","code":400,"message":"Invalid county FIPS code","data":{"errorCode":"INVALID_FIPS_CODE"}}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"404":{"description":"The order does not exist or is not visible to the caller (`order <id> doesn't exist`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"security":[{"apiKey":[]}],"summary":"Add Search to Order","tags":["Order"]},"get":{"description":"Return the requested searches associated with an order.\n\n**Related:** [Get Order Search](/reference/getordersearch)","operationId":"getOrderSearches","parameters":[{"name":"orderId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"The searches requested on the order.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderSearchesResponse"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"404":{"description":"The order does not exist or is not visible to the caller (`order <id> doesn't exist`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"security":[{"apiKey":[]}],"summary":"List Order Searches","tags":["Order"]}},"/v1/orders/{orderId}/searches/{searchId}":{"get":{"description":"Retrieve a requested search and its results for an order.","operationId":"getOrderSearch","parameters":[{"name":"orderId","required":true,"in":"path","schema":{"type":"string"}},{"name":"searchId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"The requested search, its request data and its reportable results.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderRequestedSearchExpanded"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"No reportable results are available for this order/search yet.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"404":{"description":"The order or search does not exist or is not visible to the caller, or the search belongs to another order.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"security":[{"apiKey":[]}],"summary":"Get Order Search","tags":["Order"]}},"/v1/organizations":{"get":{"description":"List organizations visible to the current caller using scoped access.\n\n**Behavior**\n\n- Includes the caller's own organizations and, for organizations where the caller holds a processor or admin role, their CRA affiliates. Super admins see all organizations. The default page size is 20.\n\n**Related:** [Get organization](/reference/getorganization) · [List affiliates](/reference/listaffiliates)","operationId":"listOrganizations","parameters":[{"name":"metadataValue","required":false,"in":"query","schema":{"type":"string"},"description":"Metadata value for metadataPath filter"},{"name":"metadataPath","required":false,"in":"query","schema":{"type":"string","pattern":"^[A-Za-z0-9_]+(\\.[A-Za-z0-9_]+)*$"},"description":"Dot-separated metadata path to filter by (requires metadataValue)"},{"name":"offset","required":false,"in":"query","schema":{"type":"integer","minimum":0,"default":0}},{"name":"limit","required":false,"in":"query","schema":{"type":"integer","minimum":1,"maximum":30,"default":20}}],"responses":{"200":{"description":"One page of organizations the caller can access, ordered by name.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationsResponse"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"`limit`, `offset` or the metadata filter is invalid; `metadataValue` requires `metadataPath`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"security":[{"apiKey":[]}],"summary":"List organizations","tags":["Organization"]}},"/v1/organizations/{organizationId}":{"get":{"description":"Get a single organization by ID if visible to the caller.","operationId":"getOrganization","parameters":[{"name":"organizationId","required":true,"in":"path","description":"Organization ID","schema":{"type":"string"}}],"responses":{"200":{"description":"The organization summary.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationResponse"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"403":{"description":"The organization is neither one of the caller's organizations nor a CRA affiliate the caller can read (`You are not authorized to access this resource`). Organization endpoints return the NestJS error body: `statusCode`, `message` and `error`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"404":{"description":"The organization does not exist or was deleted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"security":[{"apiKey":[]}],"summary":"Get organization","tags":["Organization"]}},"/v1/organizations/{organizationId}/affiliates":{"get":{"description":"Returns direct affiliates of the requested type. Defaults to CRA; PARENT lists direct children only.\n\n**Related:** [Create affiliate](/reference/createaffiliate) · [Get direct child](/reference/getchild)","operationId":"listAffiliates","parameters":[{"name":"organizationId","required":true,"in":"path","description":"Primary organization ID","schema":{"type":"string"}},{"name":"offset","required":false,"in":"query","schema":{"type":"integer","minimum":0,"default":0}},{"name":"limit","required":false,"in":"query","schema":{"type":"integer","minimum":1,"maximum":30,"default":20}},{"name":"type","required":false,"in":"query","description":"Defaults to CRA","schema":{"enum":["CRA","PARENT"],"type":"string"}}],"responses":{"200":{"description":"One page of the organization's direct affiliates of the requested type, each with its relation ID.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AffiliatesResponse"},"examples":{"craAffiliates":{"summary":"CRA affiliates of the CRA (default type=CRA)","description":"GET /v1/organizations/{CRA id}/affiliates. Results are ordered by affiliate name.","value":{"data":[{"affiliate":{"lifecycleStatus":"ACTIVE","id":"a3f1c9d2-6b4e-4c8a-b7e5-2d9f0e1a3c47","name":"Northwind Staffing","shortName":"northwind-staffing","delegateWebhooksToCra":false,"metadata":null,"createdAt":"2026-03-04T10:15:00.000Z","updatedAt":"2026-03-04T10:15:00.000Z"},"relationId":"2b6d8f0a-4c1e-4a3b-8d5f-7e9a1c3b5d02","type":"CRA"},{"affiliate":{"lifecycleStatus":"ACTIVE","id":"c8e2b4f6-1a3d-4e5b-9c7a-0f2d4b6e8a19","name":"Northwind Staffing West","shortName":"northwind-staffing-west","delegateWebhooksToCra":false,"metadata":null,"createdAt":"2026-11-01T12:00:00.000Z","updatedAt":"2026-11-01T12:00:00.000Z"},"relationId":"6f1a3c5e-8b2d-4f7a-9c1e-3d5b7f9a1c24","type":"CRA"}],"meta":{"limit":20,"offset":0,"total":2},"links":{"self":"/v1/organizations/5d7c2a8e-3f41-4b6a-9e2d-1c8f0a7b6e10/affiliates?limit=20&offset=0","next":null,"prev":null}}},"directChildren":{"summary":"Direct children of the client (type=PARENT)","description":"GET /v1/organizations/{client id}/affiliates?type=PARENT lists direct children only.","value":{"data":[{"affiliate":{"lifecycleStatus":"ACTIVE","id":"c8e2b4f6-1a3d-4e5b-9c7a-0f2d4b6e8a19","name":"Northwind Staffing West","shortName":"northwind-staffing-west","delegateWebhooksToCra":false,"metadata":null,"createdAt":"2026-11-01T12:00:00.000Z","updatedAt":"2026-11-01T12:00:00.000Z"},"relationId":"9e3c5a7b-1d4f-4b8e-a2c6-5f7d9b1e3a68","type":"PARENT"}],"meta":{"limit":20,"offset":0,"total":1},"links":{"self":"/v1/organizations/a3f1c9d2-6b4e-4c8a-b7e5-2d9f0e1a3c47/affiliates?type=PARENT&limit=20&offset=0","next":null,"prev":null}}}}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"`type` is not CRA or PARENT, or `limit` or `offset` is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"403":{"description":"The caller lacks ORGANIZATION_ADMIN, CRA_ADMIN, INTEGRATION_ADMIN, PROCESSOR or LIMITED_PROCESSOR in the path organization (`Requires processor/admin role in the primary organization`). Super admins are exempt. The body is the NestJS error body.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"404":{"description":"The organization does not exist or was deleted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"security":[{"apiKey":[]}],"summary":"List affiliates for a primary organization","tags":["Organization"]},"post":{"description":"CRA (the default) creates one CRA affiliation. PARENT creates a direct child and its separate servicing-CRA affiliation atomically; the parent must have exactly one active incoming CRA affiliation.\n\n**Related:** [List affiliates](/reference/listaffiliates) · [Affiliate package with organization](/reference/affiliatepackagewithorganization)","operationId":"createAffiliate","parameters":[{"name":"organizationId","required":true,"in":"path","description":"Primary organization ID","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAffiliateRequest"},"examples":{"child":{"summary":"Create a direct child of the client","description":"Send to the client organization. The client must have exactly one servicing CRA; the child is also affiliated with that CRA.","value":{"type":"PARENT","organization":{"name":"Northwind Staffing West","shortName":"northwind-staffing-west"}}}}}}},"responses":{"201":{"description":"The new organization, the relation ID and type, and the primary organization ID.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAffiliateResponse"},"examples":{"child":{"summary":"Child created","description":"`relationId` identifies the relationship, not the child organization. Use `organization.id` as the child organization ID.","value":{"organization":{"lifecycleStatus":"ACTIVE","id":"c8e2b4f6-1a3d-4e5b-9c7a-0f2d4b6e8a19","name":"Northwind Staffing West","shortName":"northwind-staffing-west","delegateWebhooksToCra":false,"metadata":null,"createdAt":"2026-11-01T12:00:00.000Z","updatedAt":"2026-11-01T12:00:00.000Z"},"relationId":"9e3c5a7b-1d4f-4b8e-a2c6-5f7d9b1e3a68","type":"PARENT","primaryOrganizationId":"a3f1c9d2-6b4e-4c8a-b7e5-2d9f0e1a3c47"}}}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Request validation failed (for example `type` is not CRA or PARENT), or for PARENT the parent does not have exactly one servicing CRA (`Parent must have exactly one servicing CRA`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"403":{"description":"The caller lacks ORGANIZATION_ADMIN, CRA_ADMIN, INTEGRATION_ADMIN or PROCESSOR in the primary organization (`Requires admin or processor role in the primary organization`). Super admins are exempt. The body is the NestJS error body.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"404":{"description":"The primary organization does not exist or was deleted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"409":{"description":"An organization with conflicting unique details (e.g. shortName) already exists","headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"security":[{"apiKey":[]}],"summary":"Create a new CRA affiliate or direct child organization","tags":["Organization"]}},"/v1/organizations/{organizationId}/children/{childId}":{"get":{"operationId":"getChild","parameters":[{"name":"organizationId","required":true,"in":"path","description":"Parent organization ID","schema":{"type":"string"}},{"name":"childId","required":true,"in":"path","description":"Direct child organization ID","schema":{"type":"string"}}],"responses":{"200":{"description":"The direct child organization.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationResponse"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"403":{"description":"The caller lacks a processor or admin role in the parent organization (`Requires processor/admin role in the primary organization`). The body is the NestJS error body.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"404":{"description":"The organization is not a direct child of the parent (`Direct child organization not found`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"security":[{"apiKey":[]}],"summary":"Get a direct child of an authorized parent organization","tags":["Organization"],"description":"**Behavior**\n\n- Returns the organization only when it is a direct PARENT-relation child of the path organization; children of children are not returned.\n\n**Related:** [List affiliates](/reference/listaffiliates)"}},"/v1/packages":{"get":{"description":"Retrieve the available package sets for the organization.\n\n**Related:** [Create vID Invite](/reference/createvidinvite-1) · [Package](/docs/package)","operationId":"listPackageSets","parameters":[],"responses":{"200":{"description":"Active packages visible to the caller that have an owning organization, ordered by name. Use `id` as `packageId`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPackageSetsResponse"},"examples":{"sharedPackage":{"summary":"A CRA-owned package shared with the client","description":"Use `id` as `packageId`. `organizationId` is the owning organization, here the CRA.","value":{"packageSets":[{"id":"81eb7401-8ff0-4404-8450-4d7508482c19","name":"Standard ID Verification","shortName":"standard-idv","description":null,"amount":0,"currency":"USD","amountPrecision":"TWO_DECIMALS","isActive":true,"organizationId":"5d7c2a8e-3f41-4b6a-9e2d-1c8f0a7b6e10"}]}}}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"security":[{"apiKey":[]}],"summary":"List Package Sets","tags":["Packages"]}},"/v1/packages/{packageId}/affiliate":{"post":{"description":"Grants a specific organization access to the selected package.\n\n**Related:** [CRA Package Access](/docs/cra-package-access)","operationId":"affiliatePackageWithOrganization","parameters":[{"name":"packageId","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AffiliatePackageRequest"},"examples":{"client":{"summary":"Grant the client organization access","value":{"organizationId":"a3f1c9d2-6b4e-4c8a-b7e5-2d9f0e1a3c47"}}}}}},"responses":{"201":{"description":"Package access granted; returns the new access record.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AffiliatePackageResponse"},"examples":{"granted":{"summary":"Access granted","value":{"id":"4a8c2e6f-0b3d-4d5a-8f1c-6e2a4c8b0d93","packageSetId":"81eb7401-8ff0-4404-8450-4d7508482c19","organizationId":"a3f1c9d2-6b4e-4c8a-b7e5-2d9f0e1a3c47","createdAt":"2026-03-04T10:20:00.000Z","updatedAt":"2026-03-04T10:20:00.000Z"}}}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"`organizationId` is missing or not a string (request validation), or contains only whitespace (`organizationId is required`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"404":{"description":"The package does not exist or is not visible to the caller (`Package not found`), or the organization does not exist (`Unable to affiliate package with this organization.`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"409":{"description":"The organization already has access to this package.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"security":[{"apiKey":[]}],"summary":"Affiliate package with organization","tags":["Packages"]}},"/v1/public/wallet-shares/{token}":{"get":{"description":"Returns credential payload data from a valid temporary share token.","operationId":"getSharedCredential","parameters":[{"name":"token","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"The shared credential's public view.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WalletSharePublicCredentialResponse"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"404":{"description":"The share token is invalid, expired or revoked (`Wallet share not found`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"summary":"Get Shared Wallet Credential","tags":["Wallet Shares"]}},"/v1/public/wallet-shares/{token}/files/{fileId}":{"get":{"description":"Streams an attachment file from a valid temporary share token and credential file id.","operationId":"getSharedCredentialFile","parameters":[{"name":"token","required":true,"in":"path","schema":{"type":"string"}},{"name":"fileId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Binary file body (not JSON). Content-Type reflects the stored file MIME type (default application/octet-stream). Content-Disposition is inline for common image MIME types and attachment otherwise.","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}},"application/pdf":{"schema":{"type":"string","format":"binary"}},"image/jpeg":{"schema":{"type":"string","format":"binary"}},"image/png":{"schema":{"type":"string","format":"binary"}},"image/gif":{"schema":{"type":"string","format":"binary"}},"image/webp":{"schema":{"type":"string","format":"binary"}},"image/svg+xml":{"schema":{"type":"string","format":"binary"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"404":{"description":"The share token is invalid, expired or revoked, or the file does not belong to the shared credential.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"summary":"Get Shared Wallet Credential File","tags":["Wallet Shares"]}},"/v1/results/{id}/classifications":{"get":{"description":"Retrieve the classifications associated with a result record.\n\n**Behavior**\n\n- Returns 404 `Result not found` when the result does not exist or is not visible to the caller.","operationId":"getClassifications","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"The result's classifications and the disclosure text.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetClassificationsResponse"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"security":[{"apiKey":[]}],"summary":"Get Classifications","tags":["Result"]}},"/v1/results/{id}/recommended-search-counties":{"get":{"description":"Retrieve recommended county searches from result status metadata.\n\n**Behavior**\n\n- Returns 404 `Result not found` when the result does not exist or is not visible to the caller.\n\n**Related:** [Add Search to Order](/reference/createrequestedsearchfororder)","operationId":"getRecommendedSearchCounties","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Recommended county searches from the result, with the disclosure text.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRecommendedSearchCountiesResponse"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"security":[{"apiKey":[]}],"summary":"Get Recommended Search Counties","tags":["Result"]}},"/v1/results/{id}/reportable-charges":{"patch":{"description":"Replace the list of reportable charges on a result record.\n\n**Behavior**\n\n- The change is recorded as a new result revision that replaces `/normalized/reportableCharges`, attributed to the caller.","operationId":"updateReportableCharges","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateReportableChargesRequest"}}}},"responses":{"200":{"description":"The ID of the result whose reportable charges were replaced.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateReportableChargesResponse"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"404":{"description":"The result does not exist or is not visible to the caller (`Result not found`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"security":[{"apiKey":[]}],"summary":"Update Reportable Charges","tags":["Result"]}},"/v1/results/{id}/synapse-processing-completion":{"post":{"description":"Idempotently record one expected Synapse process as terminal and queue order reconciliation once the fan-in barrier closes.","operationId":"acknowledgeSynapseProcessing","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcknowledgeSynapseProcessingRequest"}}}},"responses":{"201":{"description":"Whether the process is tracked, was already complete, whether every expected process is now complete, and whether reconciliation was queued.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcknowledgeSynapseProcessingResponse"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"The process acknowledgement is not accepted for this result (the message begins `Synapse process`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"404":{"description":"The result does not exist or is not visible to the caller (`Result not found`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"security":[{"apiKey":[]}],"summary":"Acknowledge Synapse Processing Completion","tags":["Result"]}},"/v1/schema/aamva-search.schema.json":{"get":{"description":"Retrieve the JSON Schema definition for AAMVA search. This schema defines the expected format and validation rules for AAMVA search queries used within the system.","operationId":"getAamvaSearchSchema","parameters":[],"responses":{"200":{"description":"The AAMVA search JSON Schema.","content":{"application/json":{"schema":{"type":"object"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"summary":"Get AAMVA Search Schema","tags":["Schema"]}},"/v1/schema/criminal-case.schema.json":{"get":{"description":"Retrieve the JSON Schema definition for criminal case data structure. This schema defines the expected format and validation rules for criminal case records.","operationId":"getCriminalCaseSchema","parameters":[],"responses":{"200":{"description":"The criminal case JSON Schema.","content":{"application/json":{"schema":{"type":"object"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"summary":"Get Criminal Case Schema","tags":["Schema"]}},"/v1/schema/identity-recheck-result.schema.json":{"get":{"description":"Retrieve the JSON Schema definition for Identity Re-check normalized results and recorded evidence blobs.","operationId":"getIdentityRecheckResultSchema","parameters":[],"responses":{"200":{"description":"The identity re-check result JSON Schema.","content":{"application/json":{"schema":{"type":"object"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"summary":"Get Identity Re-check Result Schema","tags":["Schema"]}},"/v1/schema/organization-metadata.schema.json":{"get":{"description":"Retrieve the JSON Schema definitions for organization metadata. This schema defines the expected format and validation rules for organization metadata used within the system.","operationId":"getOrganizationMetadataSchemas","parameters":[],"responses":{"200":{"description":"The organization metadata JSON Schemas.","content":{"application/json":{"schema":{"type":"object"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"summary":"Get Organization Metadata Schemas","tags":["Schema"]}},"/v1/schema/package-set-metadata.schema.json":{"get":{"description":"Retrieve the JSON Schema definition for package set metadata. This schema defines the expected format and validation rules for configuring package sets, including vendor-specific settings and search parameters.","operationId":"getPackageSetMetadataSchema","parameters":[],"responses":{"200":{"description":"The package set metadata JSON Schema.","content":{"application/json":{"schema":{"type":"object"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"summary":"Get Package Set Metadata Schema","tags":["Schema"]}},"/v1/schema/reportable-results.schema.json":{"get":{"description":"Retrieve the JSON Schema definition for the Order.reportableResults data structure.","operationId":"getReportableResultsSchema","parameters":[],"responses":{"200":{"description":"The reportable results JSON Schema.","content":{"application/json":{"schema":{"type":"object"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"summary":"Get Reportable Results Schema","tags":["Schema"]}},"/v1/schema/sex-offender-registry-result.schema.json":{"get":{"description":"Retrieve the JSON Schema definition for sex offender registry result data structure.","operationId":"getSexOffenderRegistryResultSchema","parameters":[],"responses":{"200":{"description":"The sex offender registry result JSON Schema.","content":{"application/json":{"schema":{"type":"object"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"summary":"Get Sex Offender Registry Result Schema","tags":["Schema"]}},"/v1/tazworks/native-order":{"post":{"description":"Create a vID invite using a native TazWorks order payload.\n\n**Behavior**\n\n- Creates an emailed invite with `vidPackage` as the package ID and the whole request body stored as invite metadata. A pending invite for the same package, email and organization is reused, as in Create vID Invite.\n\n**Related:** [Create vID Invite](/reference/createvidinvite-1) · [Tazworks Integration](/docs/tazworks-integration)","operationId":"createNativeOrder","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TazworksNativeOrderRequest"}}}},"responses":{"201":{"description":"vID invite created or reused for the TazWorks order. Retain `inviteId`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateVIDInviteResponse"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"`vidPackage` does not identify a package visible to the caller (`invalid packageId: <id>`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"403":{"description":"The package owner's organization is not visible to the caller (`organizationId is not accessible`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"security":[{"apiKey":[]}],"summary":"Create TazWorks native order","tags":["TazWorks"]}},"/v1/tazworks/results":{"post":{"description":"Record a TazWorks decision update and its scores. Completed orders also require a PDF for background processing.\n\n**Behavior**\n\n- The update is processed asynchronously, queued per matching dispatched search.","operationId":"receiveResult","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TazworksResultRequest"}}}},"responses":{"202":{"description":"Result update accepted for background processing (`accepted: true`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TazworksResultAcceptedResponse"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"403":{"description":"Only super administrators can submit TazWorks results.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"404":{"description":"No TazWorks dispatched search has a `vendorRequestId` equal to `tazworksOrderId` (`No matching TazWorks dispatched search was found`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"security":[{"apiKey":[]}],"summary":"Accept a TazWorks result update","tags":["TazWorks"]}},"/v1/users":{"get":{"description":"Retrieve paginated users with optional filters.","operationId":"getUsers","parameters":[{"name":"userIds","required":false,"in":"query","description":"Filter by one or more user IDs","schema":{"type":"array","items":{"type":"string"}}},{"name":"limit","required":false,"in":"query","schema":{"type":"integer","minimum":1,"maximum":30}},{"name":"offset","required":false,"in":"query","schema":{"type":"integer","minimum":0}},{"name":"metadata","required":false,"in":"query","description":"URL-encoded JSON object used to filter order additionalMetadata by exact JSON path/value matches.","schema":{"type":"string"}},{"name":"organizationId","required":false,"in":"query","description":"Filter by organization ID","schema":{"type":"string"}},{"name":"email","required":false,"in":"query","description":"Filter by user email","schema":{"type":"string"}},{"name":"packageId","required":false,"in":"query","description":"Filter by package ID","schema":{"type":"string"}},{"name":"status","required":false,"in":"query","description":"Filter by order status","schema":{"enum":["PENDING","IN_PROGRESS","IN_DISPUTE","COMPLETE","INCOMPLETE"],"type":"string"}}],"responses":{"200":{"description":"One page of users visible to the caller, with pagination metadata and links.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserListResponse"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"`limit` is not an integer from 1 to 30, or `offset` is not a non-negative integer.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"security":[{"apiKey":[]}],"summary":"List Users","tags":["User"]}},"/v1/vid/invites":{"post":{"description":"Create a new vID invite for the provided applicant details.\n\n**Behavior**\n\n- Reuse: unless `forceNewInvite` is true, an existing PENDING or STARTED invite without an order for the same package, email (case-insensitive) and organization is reused. It keeps its `inviteId`, its expiry is renewed from the package's invite period (30 days by default), and supplied names replace the stored ones. Other stored fields, such as metadata, postback URL and phone number, are not changed. `inviteData` echoes the request.\n- `forceNewInvite: true` always creates a new invite. Existing invites are left unchanged.\n- `organizationId` defaults to the package's owning organization.\n- With the default delivery method EMAIL, the invite email is queued; reminder emails are scheduled when the package enables them. Use List vID Invites or Get vID Invite to follow the invite; once the applicant submits, Get vID Invite returns its `orderId`.\n\n**Related:** [Get vID Invite](/reference/getvidinvitestatus-1) · [List vID Invites](/reference/getvidinvites) · [Invite](/docs/invite) · [Event Types](/docs/event-types)","operationId":"createVIDInvite","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateVIDInviteRequest"},"examples":{"minimal":{"summary":"Minimal web invite","description":"Only `contactInformation.email` and `packageId` are required. `phoneNumber` is optional.","value":{"packageId":"81eb7401-8ff0-4404-8450-4d7508482c19","deliveryMethod":"EMAIL","web":true,"contactInformation":{"email":"applicant@example.com","firstName":"Jordan","lastName":"Lee"},"metadata":{"clientReferenceId":"APP-1042"}}},"forClient":{"summary":"Invite owned by an organization that uses a shared package","value":{"packageId":"81eb7401-8ff0-4404-8450-4d7508482c19","organizationId":"a3f1c9d2-6b4e-4c8a-b7e5-2d9f0e1a3c47","deliveryMethod":"EMAIL","web":true,"contactInformation":{"email":"applicant@example.com","firstName":"Jordan","lastName":"Lee"},"metadata":{"clientReferenceId":"APP-1042"}}}}}}},"responses":{"201":{"description":"Invite created or reused. Retain `inviteId`: Get, Resend and Cancel vID Invite use it.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateVIDInviteResponse"},"examples":{"created":{"summary":"Invite created","description":"Store `inviteId`. Send the applicant `vIDWebInviteUrl` for a web invite. URL and QR values are shortened placeholders.","value":{"inviteId":"8faf4d07-6fec-43b8-a32c-cd549c30b5e9","packageId":"81eb7401-8ff0-4404-8450-4d7508482c19","packageName":"Standard ID Verification","vIDInviteUrl":"https://cerebrum.app.link/EXAMPLE","vIDWebInviteUrl":"https://cognition.cerebrum.com/vid/i/EXAMPLE","vIDQRCode":"data:image/png;base64,iVBORw0KGgo=","vIDShortCode":"ABC123","inviteExpiry":"2026-12-02","inviteData":{"contactInformation":{"email":"applicant@example.com","firstName":"Jordan","lastName":"Lee"},"metadata":{"clientReferenceId":"APP-1042"}}}}}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"`packageId` does not identify a package visible to the caller (`invalid packageId: <id>`), or `passTypeId` is unknown (`invalid passTypeId: <id>`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"403":{"description":"The organization (`organizationId`, or the package's owner) does not exist or is not visible to the caller (`organizationId is not accessible`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"500":{"description":"Unexpected server error, including when the package has no owning organization.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"security":[{"apiKey":[]}],"summary":"Create vID Invite","tags":["vID"]},"get":{"description":"Read-only lookup of existing vID invites by email and status. Returns paginated results with expiry and available links.\n\n**Behavior**\n\n- The `email` filter must be an email address and is an exact, case-insensitive match. `status` must be an invite status.\n\n**Related:** [Get vID Invite](/reference/getvidinvitestatus-1)","operationId":"getVIDInvites","parameters":[{"name":"status","required":false,"in":"query","description":"Filter by persisted invite status. Check inviteExpiry separately for expiry.","schema":{"type":"string","enum":["PENDING","STARTED","COMPLETE","ACCEPTED","CANCELED","OPT_OUT"]}},{"name":"email","required":false,"in":"query","description":"Case-insensitive exact applicant email filter","schema":{"type":"string"}},{"name":"limit","required":false,"in":"query","description":"Page size; defaults to 10 even when no pagination is supplied","schema":{"minimum":1,"maximum":30,"default":10,"type":"integer"}},{"name":"offset","required":false,"in":"query","description":"Number of matching invites to skip","schema":{"minimum":0,"default":0,"type":"integer"}}],"responses":{"200":{"description":"One page of invites, newest first, with expiry and invite link.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetVIDInvitesResponse"},"examples":{"byEmail":{"summary":"Filter by applicant email","description":"GET /v1/vid/invites?email=applicant%40example.com","value":{"invites":[{"id":"8faf4d07-6fec-43b8-a32c-cd549c30b5e9","status":"PENDING","createdAt":"2026-11-02T15:04:05.000Z","updatedAt":"2026-11-02T15:04:05.000Z","firstName":"Jordan","middleName":null,"lastName":"Lee","email":"applicant@example.com","packageSetId":"81eb7401-8ff0-4404-8450-4d7508482c19","metadata":{"clientReferenceId":"APP-1042"},"inviteExpiry":"2026-12-02T15:04:05.000Z"}],"meta":{"limit":10,"offset":0,"total":1},"links":{"self":"/v1/vid/invites?email=applicant%40example.com&limit=10&offset=0","next":null,"prev":null}}}}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"security":[{"apiKey":[]}],"summary":"List vID Invites","tags":["vID"]}},"/v1/vid/invites/{id}":{"get":{"description":"Retrieve the status and order details for a specific vID invite.\n\n**Related:** [Get Order Details](/reference/getorder-1)","operationId":"getVIDInviteStatus","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"The invite's status and order ID, with an order summary once the applicant has submitted an order.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetVIDInviteStatusResponse"},"examples":{"pending":{"summary":"No order yet","description":"`orderId` is null and `order` is omitted until the applicant submits.","value":{"inviteId":"8faf4d07-6fec-43b8-a32c-cd549c30b5e9","status":"PENDING","orderId":null}},"submitted":{"summary":"Order created from the invite","description":"Retrieve the order with Get Order Details for its metadata and expansions.","value":{"inviteId":"8faf4d07-6fec-43b8-a32c-cd549c30b5e9","status":"COMPLETE","orderId":"0bb0f6f8-459f-482a-952e-7caf029517f6","order":{"id":"0bb0f6f8-459f-482a-952e-7caf029517f6","backgroundReportUrl":"https://cognition.cerebrum.com/user/e4b7d1c3-9a2f-4f6e-8d1b-3c5a7e9f2b64?tab=Documents","additionalMetadata":{},"status":"COMPLETE","score":"ID_VERIFIED","alert":"NO_ALERTS_FOUND","createdAt":"2026-11-03T16:20:00.000Z","updatedAt":"2026-11-03T16:27:41.000Z"}}}}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"The invite does not exist or is not visible to the caller (`invalid id: <id>`). This case returns 400, not 404.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"security":[{"apiKey":[]}],"summary":"Get vID Invite","tags":["vID"]}},"/v1/vid/invites/{id}/cancel":{"post":{"description":"Cancel a pending or started vID invite and mark it as canceled.\n\n**Behavior**\n\n- Only PENDING or STARTED invites without an order can be canceled.","operationId":"cancelVIDInvite","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"201":{"description":"Invite canceled. Returns the invite `id` and `status: CANCELED` under `data`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelVIDInviteResponse"},"examples":{"canceled":{"summary":"Invite canceled","value":{"data":{"id":"8faf4d07-6fec-43b8-a32c-cd549c30b5e9","status":"CANCELED"}}}}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"The invite is not PENDING or STARTED, or it already has an order (`Only pending or started invites without an order can be canceled`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"404":{"description":"The invite does not exist or is not visible to the caller (`vID voucher with id <id> not found`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"security":[{"apiKey":[]}],"summary":"Cancel vID Invite","tags":["vID"]}},"/v1/vid/invites/{id}/resend":{"post":{"description":"Resend an existing pending or started vID invite to the applicant.\n\n**Behavior**\n\n- Only PENDING or STARTED invites without an order can be re-sent. Delivery is always by email.\n- If re-sending fails after those checks, the response is still 201 and the body is an error entry (`error`, `email`) instead of the invite.\n\n**Related:** [Resending Invites](/docs/resending-invites)","operationId":"resendVIDInvite","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"201":{"description":"Invite emailed again with the same `inviteId` and a renewed expiry.","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CreateVIDInviteResponse"},{"$ref":"#/components/schemas/InviteErrorResponse"}]},"examples":{"resent":{"summary":"Invite re-sent","value":{"inviteId":"8faf4d07-6fec-43b8-a32c-cd549c30b5e9","packageId":"81eb7401-8ff0-4404-8450-4d7508482c19","packageName":"Standard ID Verification","vIDInviteUrl":"https://cerebrum.app.link/EXAMPLE","vIDWebInviteUrl":"https://cognition.cerebrum.com/vid/i/EXAMPLE","vIDQRCode":"data:image/png;base64,iVBORw0KGgo=","vIDShortCode":"ABC123","inviteExpiry":"2026-12-02","inviteData":{"contactInformation":{"email":"applicant@example.com","firstName":"Jordan","lastName":"Lee"},"metadata":{"clientReferenceId":"APP-1042"}}}},"failed":{"summary":"Re-send failed after the status check","value":{"error":"Only pending or started invites without an order can be re-sent","email":"applicant@example.com"}}}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"The invite is not PENDING or STARTED, or it already has an order (`Only pending or started invites without an order can be re-sent`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"404":{"description":"The invite does not exist or is not visible to the caller (`vID voucher with id <id> not found`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"security":[{"apiKey":[]}],"summary":"Resend vID Invite","tags":["vID"]}},"/v1/vid/multiple-invites":{"post":{"description":"Create vID invites in bulk. Repeated emails are deduplicated case-insensitively per effective organization (organizationId, or the package owner when omitted).\n\n**Behavior**\n\n- Duplicate applicants after the first are dropped without an entry, so `data` can be shorter than the request. Applicants whose package cannot be resolved are not deduplicated.\n- Each remaining applicant is processed like Create vID Invite, including invite reuse unless `forceNewInvite` is true. A failed applicant does not fail the request.\n\n**Related:** [Create vID Invite](/reference/createvidinvite-1)","operationId":"createMultipleVIDInvites","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CreateVIDInviteRequest"}}}}},"responses":{"201":{"description":"One entry per applicant processed: the invite, or `error` and `email` for an applicant that failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateMultipleVIDInvitesResponse"},"examples":{"mixed":{"summary":"One invite created, one failed","value":{"data":[{"inviteId":"8faf4d07-6fec-43b8-a32c-cd549c30b5e9","packageId":"81eb7401-8ff0-4404-8450-4d7508482c19","packageName":"Standard ID Verification","vIDInviteUrl":"https://cerebrum.app.link/EXAMPLE","vIDWebInviteUrl":"https://cognition.cerebrum.com/vid/i/EXAMPLE","vIDQRCode":"data:image/png;base64,iVBORw0KGgo=","vIDShortCode":"ABC123","inviteExpiry":"2026-12-02","inviteData":{"contactInformation":{"email":"applicant@example.com","firstName":"Jordan","lastName":"Lee"},"metadata":{"clientReferenceId":"APP-1042"}}},{"error":"invalid packageId: 00000000-0000-4000-8000-000000000000","email":"second.applicant@example.com"}]}}}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"The request array is empty (`At least one applicant required`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"security":[{"apiKey":[]}],"summary":"Create Multiple vID Invites","tags":["vID"]}},"/v1/vid/quick-invite":{"post":{"description":"Generate a vID quick invite and return the redirect URL immediately.\n\n**Behavior**\n\n- No email is sent unless the request sets `deliveryMethod` to EMAIL. Invite reuse and organization rules are the same as Create vID Invite.\n\n**Related:** [Create vID Invite](/reference/createvidinvite-1)","operationId":"createVIDQuickInvite","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateVIDInviteRequest"}}}},"responses":{"201":{"description":"Invite created or reused. Returns `redirectUrl`, the vID web invite URL to send the applicant to.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateVIDQuickInviteResponse"},"examples":{"created":{"summary":"Invite created","value":{"redirectUrl":"https://cognition.cerebrum.com/vid/i/EXAMPLE"}}}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"`packageId` does not identify a package visible to the caller (`invalid packageId: <id>`), or `passTypeId` is unknown.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"403":{"description":"The organization (`organizationId`, or the package's owner) does not exist or is not visible to the caller (`organizationId is not accessible`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"security":[{"apiKey":[]}],"summary":"Create vID Quick Invite","tags":["vID"]}},"/v1/wallet/configuration":{"get":{"description":"Return wallet configuration data for accessible pass types, beams, beam input types, and credential types.","operationId":"getWalletConfiguration","parameters":[],"responses":{"200":{"description":"The pass types available for wallet credentials.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetWalletConfigurationResponse"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"security":[{"apiKey":[]}],"summary":"Get Wallet Configuration","tags":["Wallet"]}},"/v1/wallet/credentials":{"post":{"description":"Issue a wallet credential for a target user with optional PDF, DOC, DOCX, PNG, JPG, or JPEG file attachments in one request.\n\n**Related:** [Create Wallet Share Link](/reference/createwalletshare)","operationId":"createWalletCredential","parameters":[],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/CreateWalletCredentialRequest"}}}},"responses":{"200":{"description":"The issued credential: its pass, beam input and output, status and stored files.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWalletCredentialResponse"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"403":{"description":"The caller holds none of SUPER_ADMIN, ORGANIZATION_ADMIN or INTEGRATION_ADMIN (`Only integration or organization admins can issue wallet credentials`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"security":[{"apiKey":[]}],"summary":"Create Wallet Credential","tags":["Wallet"]}},"/v1/wallet/credentials/{id}":{"get":{"description":"Return one wallet credential with pass, beam, organization, status, data, and attachment metadata.","operationId":"getWalletCredential","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"The wallet credential with its pass type, beam and attachments.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetWalletCredentialResponse"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"security":[{"apiKey":[]}],"summary":"Get Wallet Credential","tags":["Wallet"]}},"/v1/wallet/credentials/{id}/status":{"patch":{"description":"Update lifecycle status for an issued wallet credential. Supports ACTIVE and REVOKED.","operationId":"updateWalletCredentialStatus","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWalletCredentialStatusRequest"}}}},"responses":{"200":{"description":"The credential ID and its new status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWalletCredentialStatusResponse"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"security":[{"apiKey":[]}],"summary":"Update Wallet Credential Status","tags":["Wallet"]}},"/v1/wallet/shares":{"post":{"description":"Create a temporary public link for a wallet credential the caller can read.\n\n**Related:** [Get Shared Wallet Credential](/reference/getsharedcredential)","operationId":"createWalletShare","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWalletShareRequest"}}}},"responses":{"200":{"description":"Temporary public share link: `token`, `url`, `displayUrl` and `expiresAt`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWalletShareResponse"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"security":[{"apiKey":[]}],"summary":"Create Wallet Share Link","tags":["Wallet"]}},"/v1/wallet/users/{userId}/credentials":{"get":{"description":"Return wallet credentials for a target user with pass, beam, organization, status, and attachment metadata.","operationId":"getWalletUserCredentials","parameters":[{"name":"userId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"The user's wallet credentials.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetWalletUserCredentialsResponse"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"headers":{"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}}},"security":[{"apiKey":[]}],"summary":"Get Wallet User Credentials","tags":["Wallet"]}}},"info":{"title":"Cortex API","description":"API docs for cortex-api","version":"18.303.2","contact":{},"x-cerebrum-contract-overlay":{"resolutions":"data/contract-resolutions.json","reviewedSource":"cerebruminc/cortex-api@865c6e284bf10cfbea9888c88a3e3794c29cd652","applied":["vid-invite-order-id","invite-order-payload","dispute-specificItem","dispute-description","upload-file-body","get-file-binary","check-order-ssn-public","scalar-CreateCredentialResponse.credentialId","scalar-GetBeamResponse.triggeredByPackageSetId","scalar-OrderSearchRequest.county","scalar-OrderSearchRequest.state","scalar-OrderSearchRequest.fipsCode","scalar-OrderSearchResultAttachment.type","scalar-PackageSetListItem.description","scalar-PackageSetListItem.organizationId","scalar-WalletCredentialFileResponse.type","credential-status-object","order-status-score-alert","expand-getOrder","expand-getAllOrders","invite-identifiers-and-expiry","pagination-shared-links","requested-search-variants","whoami-403","rate-limit-headers","status-201-createVIDInvite","status-201-resendVIDInvite","status-201-cancelVIDInvite","status-201-createMultipleVIDInvites","status-201-createVIDQuickInvite","status-201-createStandardOrder","status-201-createNativeOrder","status-201-createReportableResults","status-201-simulateWebhook","status-201-acknowledgeSynapseProcessing","status-201-createBeam","status-201-createBeamInputType","status-201-createCredentialType","response-cancelVIDInvite","response-createVIDQuickInvite","response-createMultipleVIDInvites","response-resendVIDInvite","examples-listPackageSets","examples-affiliatePackageWithOrganization","examples-createAffiliate","examples-listAffiliates","examples-createVIDInvite","examples-getVIDInvites","examples-getVIDInviteStatus","examples-getOrder","examples-getAllOrders","examples-createRequestedSearchForOrder","examples-submitDispute","examples-uploadFile","examples-checkOrderForSSN"]},"x-cerebrum-operation-behavior":{"data":"data/operation-behavior.json","reviewedSource":"cerebruminc/cortex-api@865c6e284bf10cfbea9888c88a3e3794c29cd652","operations":69}},"tags":[],"servers":[{"url":"https://api.cerebrum.com","description":"Production Environment"},{"url":"https://api.staging.cerebrum.com","description":"Staging Environment"},{"url":"https://api.dev.cerebrum.com","description":"Dev Environment"}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","in":"header","name":"apikey"}},"schemas":{"AcknowledgeSynapseProcessingRequest":{"type":"object","properties":{"processKey":{"type":"string"},"outcome":{"type":"string","enum":["COMPLETE","INCOMPLETE","REVIEW","FAILED"]},"reconcile":{"type":"boolean","description":"Whether Cortex should reconcile the order after every expected process completes."}},"required":["processKey","outcome","reconcile"]},"AcknowledgeSynapseProcessingResponse":{"type":"object","properties":{"managed":{"type":"boolean"},"alreadyCompleted":{"type":"boolean"},"allProcessed":{"type":"boolean"},"reconciliationQueued":{"type":"boolean"}},"required":["managed","alreadyCompleted","allProcessed","reconciliationQueued"]},"AffiliateListItemResponse":{"type":"object","properties":{"affiliate":{"$ref":"#/components/schemas/OrganizationSummaryResponse"},"relationId":{"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/OrgRelationTypeEnum"}]}},"required":["affiliate","relationId","type"]},"AffiliatePackageRequest":{"type":"object","properties":{"organizationId":{"type":"string","description":"Organization id to grant access to this package (typically a CRA affiliate)."}},"required":["organizationId"]},"AffiliatePackageResponse":{"type":"object","properties":{"id":{"type":"string"},"packageSetId":{"type":"string"},"organizationId":{"type":"string"},"createdAt":{"format":"date-time","type":"string"},"updatedAt":{"format":"date-time","type":"string"}},"required":["id","packageSetId","organizationId","createdAt","updatedAt"]},"AffiliatesResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AffiliateListItemResponse"}},"meta":{"$ref":"#/components/schemas/PaginationMetaResponse"},"links":{"$ref":"#/components/schemas/PaginationLinksResponse"}},"required":["data","meta","links"]},"ApplicantAddress":{"type":"object","properties":{"firstLine":{"type":"string"},"secondLine":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zipCode":{"type":"string"},"country":{"type":"string"},"addressType":{"type":"string","enum":["primary","former"]}}},"ApplicantAliasAddress":{"type":"object","properties":{"addressLineOne":{"type":"string"},"addressLineTwo":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"postalCode":{"type":"string"},"country":{"type":"string"},"addressType":{"type":"string","enum":["primary","former"]}},"required":["addressLineOne","city","state","postalCode","country","addressType"]},"ApplicantAliasData":{"type":"object","properties":{"names":{"type":"array","items":{"$ref":"#/components/schemas/ApplicantName"}},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/ApplicantAliasAddress"}},"socialSecurityNumber":{"type":"string"}},"required":["names","addresses","socialSecurityNumber"]},"ApplicantName":{"type":"object","properties":{"firstName":{"type":"string"},"middleName":{"type":"string"},"lastName":{"type":"string"},"suffix":{"type":"string"},"nameType":{"type":"string","enum":["primary","alias"]},"hasMiddleName":{"type":"boolean","description":"Indicates whether the applicant has a middle name. Defaults to false when omitted and must be true when middleName is provided."}},"required":["firstName","lastName","nameType"]},"BadRequestError":{"type":"object","properties":{"name":{"type":"string","default":"BAD_REQUEST_ERROR"},"code":{"type":"number","default":400},"message":{"type":"string","example":"Bad Request"},"data":{"type":"object","example":{}}},"required":["name","code","message","data"]},"Beam":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"triggeredByPackageSetId":{"type":"string","nullable":true},"processor":{"type":"string"},"processorConfig":{"type":"object","nullable":true,"additionalProperties":true},"organizationId":{"type":"string"},"createdAt":{"format":"date-time","type":"string"},"updatedAt":{"format":"date-time","type":"string"}},"required":["id","name","description","triggeredByPackageSetId","processor","processorConfig","organizationId","createdAt","updatedAt"]},"ChargeClassification":{"type":"object","properties":{"chargeId":{"type":"string","description":"The ID of the charge being classified. This value corresponds to the chargeId in the result data"},"class":{"type":"string","description":"The class assigned to the charge"},"subclass":{"type":"string","nullable":true,"description":"The subclass assigned to the charge, if applicable"},"matchScore":{"type":"number","description":"The match score indicating the confidence level of the classification"}},"required":["chargeId","class","subclass","matchScore"]},"CheckOrderForSSNResponse":{"type":"object","properties":{"hasSsn":{"type":"boolean","description":"Indicates whether the user associated with the order has an SSN","example":true}},"required":["hasSsn"]},"ConflictError":{"type":"object","properties":{"name":{"type":"string","default":"CONFLICT_ERROR"},"code":{"type":"number","default":409},"message":{"type":"string","example":"Conflict"}},"required":["name","code","message"]},"ContactDetails":{"type":"object","properties":{"email":{"type":"string"},"phoneNumber":{"type":"string"}},"required":["email"]},"CorporateProxyDetails":{"type":"object","properties":{"detected":{"type":"boolean","example":true},"provider":{"type":"string","nullable":true,"example":"Zscaler"}},"required":["detected","provider"]},"CreateAffiliateOrganizationPayload":{"type":"object","properties":{"lifecycleStatus":{"default":"ACTIVE","description":"Initial lifecycle status. Send INACTIVE for companies awaiting CRA approval; omitted values default to ACTIVE independently of relation type.","allOf":[{"$ref":"#/components/schemas/OrganizationLifecycleStatusEnum"}]},"name":{"type":"string"},"shortName":{"type":"string"},"legalName":{"type":"string"},"contactName":{"type":"string"},"contactEmail":{"type":"string"},"contactPhone":{"type":"string"},"website":{"type":"string"},"hexColor":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"staticSiteEnabled":{"type":"boolean"},"enableSupport":{"type":"boolean"},"delegateWebhooksToCra":{"type":"boolean"}},"required":["name","shortName"]},"CreateAffiliateRequest":{"type":"object","properties":{"type":{"description":"Defaults to CRA. PARENT creates a direct child with the parent's servicing CRA.","allOf":[{"$ref":"#/components/schemas/OrgRelationTypeEnum"}]},"organization":{"$ref":"#/components/schemas/CreateAffiliateOrganizationPayload"}},"required":["organization"]},"CreateAffiliateResponse":{"type":"object","properties":{"organization":{"$ref":"#/components/schemas/OrganizationSummaryResponse"},"relationId":{"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/OrgRelationTypeEnum"}]},"primaryOrganizationId":{"type":"string"}},"required":["organization","relationId","type","primaryOrganizationId"]},"CreateBeamInputTypeRequest":{"type":"object","properties":{"schema":{"type":"object","additionalProperties":true,"description":"JSON schema that describes the Beam input data"},"beamId":{"type":"string","description":"The id of the Beam to attach the input type to"}},"required":["schema","beamId"]},"CreateBeamInputTypeResponse":{"type":"object","properties":{"beamInputTypeId":{"type":"string","description":"The id of the created BeamInputType"},"beamInputTypeSlug":{"type":"string","description":"The slug of the created BeamInputType, used to identify different versions of the same input"}},"required":["beamInputTypeId","beamInputTypeSlug"]},"CreateBeamRequest":{"type":"object","properties":{"name":{"type":"string","description":"The name of the Beam"},"description":{"type":"string","description":"The description of the Beam"},"processor":{"type":"string","enum":["MANUAL","TAZWORKS","AUTO"],"description":"The processor used to generate credentials. One of \"MANUAL\", \"TAZWORKS\" or \"AUTO\". Defaults to \"MANUAL\""},"processorConfig":{"type":"object","description":"Any configuration required for the processor"}},"required":["name","description","processor","processorConfig"]},"CreateBeamResponse":{"type":"object","properties":{"beamId":{"type":"string","description":"The id of the created Beam"}},"required":["beamId"]},"CreateCredentialRequest":{"type":"object","properties":{"inputTypeId":{"type":"string","description":"The id of the beam input type","example":"f5f08fd9-435d-49ce-85d7-ccc748dddce0"},"userId":{"type":"string","description":"The id of the user the credential should be issued to","example":"ee5da20d-e610-4039-8fc6-00885a49cfdb"},"input":{"type":"object","description":"The data used to generate the credential, this should match the schema in the beam input type.","example":{"id":"did:example:1234","name":"John Doe","birthdate":"1990-01-01","idDocument":{"type":"Passport","number":"X12345678","country":"US","expiryDate":"2030-12-31"},"selfie":{"type":"ImageObject","contentUrl":"https://www.cerebrum.com/images/user_id/selfie.jpg","encodingFormat":"image/jpeg"},"facialVerification":{"type":"FacialVerificationResult","status":"verified","confidence":99}}}},"required":["inputTypeId","userId","input"]},"CreateCredentialResponse":{"type":"object","properties":{"inputId":{"type":"string","description":"The id of the beam input that was created"},"credentialId":{"type":"string","description":"The id of the created Credential if it is immediately available. Note that this depends on the beam processor used to generate the credential.","nullable":true}},"required":["inputId","credentialId"]},"CreateCredentialTypeRequest":{"type":"object","properties":{"schema":{"type":"object","additionalProperties":true,"description":"JSON schema that describes the stored credential data"},"beamId":{"type":"string","description":"The id of the Beam to attach the CredentialType to"}},"required":["schema","beamId"]},"CreateCredentialTypeResponse":{"type":"object","properties":{"credentialTypeId":{"type":"string","description":"The id of the created CredentialType"},"credentialTypeSlug":{"type":"string","description":"The slug of the created CredentialType, used to identify different versions of the same input"}},"required":["credentialTypeId","credentialTypeSlug"]},"CreateMultipleVIDInvitesResponse":{"type":"object","properties":{"data":{"type":"array","description":"One entry per applicant after deduplication: the invite, or an error entry for an applicant that failed.","items":{"oneOf":[{"$ref":"#/components/schemas/CreateVIDInviteResponse"},{"$ref":"#/components/schemas/InviteErrorResponse"}]}}},"required":["data"]},"CreateRequestedSearchRequest":{"description":"Choose `searchType`; `data` must match that search type. Every search type except `standardIdVerification` requires `data`. Payloads are validated against the search type's schema and rejected with 400 when they do not match. County FIPS codes and AAMVA licence states are normalized before validation.","oneOf":[{"$ref":"#/components/schemas/CreateRequestedSearchNatCrimRequest"},{"$ref":"#/components/schemas/CreateRequestedSearchCountyRequest"},{"$ref":"#/components/schemas/CreateRequestedSearchSsnRequest"},{"$ref":"#/components/schemas/CreateRequestedSearchIdentityRecheckRequest"},{"$ref":"#/components/schemas/CreateRequestedSearchStandardIdVerificationRequest"},{"$ref":"#/components/schemas/CreateRequestedSearchAamvaRequest"},{"$ref":"#/components/schemas/CreateRequestedSearchFastTrackRequest"},{"$ref":"#/components/schemas/CreateRequestedSearchTazworksRequest"}],"discriminator":{"propertyName":"searchType","mapping":{"nat+crim":"#/components/schemas/CreateRequestedSearchNatCrimRequest","county":"#/components/schemas/CreateRequestedSearchCountyRequest","ssn":"#/components/schemas/CreateRequestedSearchSsnRequest","identityRecheck":"#/components/schemas/CreateRequestedSearchIdentityRecheckRequest","standardIdVerification":"#/components/schemas/CreateRequestedSearchStandardIdVerificationRequest","aamva":"#/components/schemas/CreateRequestedSearchAamvaRequest","fastTrack":"#/components/schemas/CreateRequestedSearchFastTrackRequest","tazworks":"#/components/schemas/CreateRequestedSearchTazworksRequest"}}},"CreateRequestedSearchResponse":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"CreateVIDInviteRequest":{"type":"object","properties":{"packageId":{"type":"string","description":"Package ID: the `id` returned by List Package Sets (a UUID). The package may be owned by your organization or shared with it.","example":"81eb7401-8ff0-4404-8450-4d7508482c19"},"organizationId":{"type":"string","description":"The ID of the organization for the invite. If not provided, the organization from the package will be used.","example":"a3f1c9d2-6b4e-4c8a-b7e5-2d9f0e1a3c47","nullable":true},"passTypeId":{"type":"string","description":"The id of the pass type used for the invite","example":"4d5a7cfd-f8f4-407a-92c0-0215e0b798e5"},"postbackWebhookUrl":{"type":"string","description":"The URL that webhooks will be sent to when an order is completed","example":"https://example.com/webhook"},"metadata":{"type":"object","description":"Additional metadata to include in the invite request. Can be any valid JSON Object","example":{"any_key":"value"}},"contactInformation":{"description":"Applicant email address & phone number","example":{"email":"johndoe@gmail.com","phoneNumber":"2087444184","firstName":"John","middleName":"M","lastName":"Doe","suffix":"Jr.","dateOfBirth":"1990-12-31","primaryContactMethod":"EMAIL"},"allOf":[{"$ref":"#/components/schemas/VoucherContactInformation"}]},"deliveryMethod":{"type":"string","description":"The Delivery method used to send an invite to the applicant","enum":["EMAIL","NONE"],"example":"EMAIL"},"web":{"type":"boolean","description":"This boolean indicates whether to create a web invite or app invite. Default: false","default":false},"onSubmitReturnUrl":{"type":"string","description":"The url where the user will be redirected after submitting their vID order"},"forceNewInvite":{"type":"boolean","description":"Always create a new invite instead of reusing an existing pending invite or voucher.","default":false},"origin":{"type":"string","description":"The platform that originated this voucher.","enum":["COGNITION","CORTEX","MYCELIUM"]}},"required":["packageId","contactInformation","deliveryMethod"]},"CreateVIDInviteResponse":{"type":"object","properties":{"inviteId":{"type":"string","description":"The ID of the newly created invite","example":"8faf4d07-6fec-43b8-a32c-cd549c30b5e9"},"packageId":{"type":"string","description":"The id of the package used for the order","example":"81eb7401-8ff0-4404-8450-4d7508482c19"},"packageName":{"type":"string","description":"The name of the package","example":"Standard ID Verification"},"vIDInviteUrl":{"type":"string","description":"URL of the vID invite","example":"https://cerebrum.app.link/fMPAbcUQNXyb"},"vIDWebInviteUrl":{"type":"string","description":"URL of the vID Web invite","example":"https://cognition.cerebrum.com/vid/i/ey....."},"vIDQRCode":{"type":"string","description":"QR CODE of the vID invite","example":"data:image/png;base64,iVBORw0K....."},"vIDShortCode":{"type":"string","description":"shortcode that can be used in vID to redeem invite","example":"ABC123"},"inviteExpiry":{"type":"string","description":"Date (YYYY-MM-DD) on which the invite expires. Set from the package's invite expiration period: 30 days unless the package is configured otherwise. When an existing pending invite is reused, its expiry is renewed. List vID Invites returns the full timestamp.","example":"2026-12-02"},"inviteData":{"description":"The data that was provided when creating the invite","allOf":[{"$ref":"#/components/schemas/vIDInviteResponseInviteData"}]}},"required":["inviteId","packageId","packageName","vIDInviteUrl","vIDWebInviteUrl","vIDQRCode","vIDShortCode","inviteExpiry","inviteData"]},"CreateWalletCredentialRequest":{"type":"object","properties":{"orderId":{"type":"string","example":"ORD-123"},"userId":{"type":"string","example":"0a39b60c-5d02-4587-9218-bac874675899"},"passTypeId":{"type":"string","example":"PAT-123"},"beamId":{"type":"string","example":"BEA-123"},"data":{"type":"object","additionalProperties":true,"description":"JSON payload; structure must match the BeamInputType schema"},"credentialData":{"type":"object","additionalProperties":true},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/WalletCredentialAttachment"}}},"required":["beamId","data"]},"CreateWalletCredentialResponse":{"type":"object","properties":{"passId":{"type":"string","nullable":true},"beamInputId":{"type":"string"},"beamOutputId":{"type":"string"},"credentialId":{"type":"string"},"status":{"type":"string","example":"ACTIVE"},"files":{"type":"array","items":{"$ref":"#/components/schemas/WalletCredentialFileResponse"}}},"required":["passId","beamInputId","beamOutputId","credentialId","status","files"]},"CreateWalletShareRequest":{"type":"object","properties":{"credentialId":{"type":"string","description":"Wallet credential to expose via the share link. Caller must have read access via RBAC."}},"required":["credentialId"]},"CreateWalletShareResponse":{"type":"object","properties":{"token":{"type":"string"},"url":{"type":"string"},"displayUrl":{"type":"string"},"expiresAt":{"type":"string","description":"When the share link stops working (ISO 8601)","format":"date-time","example":"2026-05-13T12:34:56.789Z"}},"required":["token","url","displayUrl","expiresAt"]},"CredentialStatusEnum":{"type":"string","enum":["PENDING","ACTIVE","REVOKED"]},"CredentialStatusResponse":{"type":"object","properties":{"status":{"type":"string"}},"required":["status"]},"CriminalCaseSchemaAddress":{"type":"object","properties":{"raw":{"type":"string"},"addressLineOne":{"type":"string"},"addressLineTwo":{"type":"string","nullable":true},"city":{"type":"string"},"county":{"type":"string","nullable":true},"state":{"type":"string"},"postalCode":{"type":"string"},"country":{"type":"string"}},"required":["raw","addressLineOne","city","state","postalCode","country"]},"CriminalCaseSchemaName":{"type":"object","properties":{"raw":{"type":"string"},"first":{"type":"string"},"middle":{"type":"string","nullable":true},"last":{"type":"string"},"suffix":{"type":"string","nullable":true},"prefix":{"type":"string","nullable":true}},"required":["first","last"]},"CurrencyMultiplierEnum":{"type":"string","enum":["ZERO_DECIMALS","TWO_DECIMALS","FOUR_DECIMALS","SIX_DECIMALS"]},"CurrencyTypeEnum":{"type":"string","enum":["USD","CAD","GBP","EUR"]},"CustomApplicantDataType":{"type":"object","properties":{"names":{"type":"array","items":{"$ref":"#/components/schemas/ApplicantName"}},"dateOfBirth":{"type":"string","description":"Preferred format is YYYY-MM-DD. Other common date formats are accepted and normalized to YYYY-MM-DD."},"socialSecurityNumber":{"type":"string"},"hasSSN":{"type":"boolean"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/ApplicantAddress"}},"contactInformation":{"$ref":"#/components/schemas/ContactDetails"}},"required":["names","dateOfBirth","hasSSN","contactInformation"]},"DisputeDetails":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the dispute","example":"9d3e5f7a-8b2c-4a1e-9f6d-7c8b5a4e3d2f"},"orderId":{"type":"string","description":"The order ID that the dispute is related to","example":"0bb0f6f8-459f-482a-952e-7caf029517f6"},"consumerName":{"type":"string","description":"Full name of the consumer who submitted the dispute","example":"John Doe"},"consumerEmail":{"type":"string","description":"Email address of the consumer","example":"john.doe@example.com","nullable":true},"consumerPhone":{"type":"string","description":"Phone number of the consumer","example":"+1-555-123-4567","nullable":true},"last4Ssn":{"type":"string","description":"Last 4 digits of the consumer's SSN","example":"1234","nullable":true},"dob":{"type":"string","description":"Date of birth","example":"1990-01-15","nullable":true},"specificItem":{"type":"string","description":"A reference to a particular item in the report being disputed","example":"Criminal record from 2015 in Los Angeles County","nullable":true},"reason":{"type":"string","description":"The reason for the dispute","enum":["DISMISSED_OR_EXPUNGED","INACCURATE_RECORDS","NOT_MY_RECORDS","INACCURATE_INFORMATION","NOT_MY_INFORMATION","CLARIFICATION_ON_CRIMINAL_RECORDS","CLARIFICATION_ON_INFORMATION","VICTIM_OF_HUMAN_TRAFFICKING","OTHER"],"example":"INACCURATE_RECORDS"},"description":{"type":"string","description":"Additional details about the dispute","example":"The record shows an incorrect conviction date","nullable":true},"status":{"type":"string","description":"The status of the dispute","enum":["OPEN","IN_PROGRESS","RESOLVED"],"example":"OPEN"},"resolutionOutcome":{"type":"string","description":"The explicit dispute resolution outcome","enum":["RESULTS_CHANGED","RESULTS_UNCHANGED"],"nullable":true},"createdAt":{"format":"date-time","type":"string","description":"Timestamp when the dispute was created","example":"2026-02-16T10:30:00.000Z"},"updatedAt":{"format":"date-time","type":"string","description":"Timestamp when the dispute was last updated","example":"2026-02-16T10:30:00.000Z"}},"required":["id","orderId","consumerName","reason","status","resolutionOutcome","createdAt","updatedAt"]},"DisputeListResponse":{"type":"object","properties":{"data":{"description":"List of disputes","type":"array","items":{"$ref":"#/components/schemas/DisputeDetails"}}},"required":["data"]},"DocumentSpecificData":{"type":"object","properties":{"type":{"type":"string","enum":["StateIdentificationCard","Passport","InternationalIdentificationCard"],"example":"StateIdentificationCard"},"documentType":{"type":"string","enum":["None","ConsularId","Dl","DlPublicServicesCard","EmploymentPass","FinCard","Id","MultipurposeId","MyKad","MyKid","MyPr","MyTentera","PanCard","ProfessionalId","PublicServicesCard","ResidencePermit","ResidentId","TemporaryResidencePermit","VoterId","WorkPermit","IKad","MilitaryId","MyKas","SocialSecurityCard","HealthInsuranceCard","Passport","SPass","AddressCard","AlienId","AlienPassport","GreenCard","MinorsId","PostalId","ProfessionalDl","TaxId","WeaponPermit","Visa","BorderCrossingCard","DriverCard","GlobalEntryCard","MyPolis","NexusCard","PassportCard","ProofOfAgeCard","RefugeeId","TribalId","VeteranId","CitizenshipCertificate","MyNumberCard","ConsularPassport","MinorsPassport","MinorsPublicServicesCard","DrivingPrivilegeCard","AsylumRequest","DriverQualificationCard","ProvisionalDl","RefugeePassport","SpecialId","UniformedServicesId","ImmigrantVisa","ConsularVoterId","TwicCard","ExitEntryPermit","MainlandTravelPermitTaiwan","NbiClearance","ProofOfRegistration","TemporaryProtectionPermit","AfghanCitizenCard","Eid","Pass","SisId","AsicCard","BidoonCard","InterimHealthInsuranceCard","NonVoterId","ReciprocalHealthInsuranceCard","VehicleRegistration"]},"number":{"type":"string"},"nationality":{"type":"string"},"placeOfBirth":{"type":"string"},"expiryDate":{"type":"string"},"issueDate":{"type":"string"}},"required":["type","number","expiryDate","issueDate"]},"FileUploadResponse":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the uploaded file","format":"uuid"},"key":{"type":"string","description":"Storage key of the uploaded file. Informational; use `id` to refer to the file."}},"required":["id","key"]},"ForbiddenError":{"type":"object","properties":{"name":{"type":"string","default":"FORBIDDEN_ERROR"},"code":{"type":"number","default":403},"message":{"type":"string","example":"Forbidden"}},"required":["name","code","message"]},"GetBeamInputTypeResponse":{"type":"object","properties":{"id":{"type":"string"},"beamId":{"type":"string"},"slug":{"type":"string"},"version":{"type":"string"},"createdAt":{"format":"date-time","type":"string"},"schema":{"type":"object","additionalProperties":true},"organizationId":{"type":"string","nullable":true},"beam":{"$ref":"#/components/schemas/Beam"}},"required":["id","beamId","slug","version","createdAt","schema","organizationId","beam"]},"GetBeamResponse":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"triggeredByPackageSetId":{"type":"string","nullable":true},"processor":{"type":"string"},"processorConfig":{"type":"object","additionalProperties":true},"organizationId":{"type":"string"},"createdAt":{"format":"date-time","type":"string"},"updatedAt":{"format":"date-time","type":"string"},"inputTypes":{"type":"array","items":{"type":"string"}},"credentialTypes":{"type":"array","items":{"type":"string"}}},"required":["id","name","description","triggeredByPackageSetId","processor","processorConfig","organizationId","createdAt","updatedAt","inputTypes","credentialTypes"]},"GetClassificationsResponse":{"type":"object","properties":{"data":{"type":"object","description":"The result data"},"classifications":{"description":"List of charge classifications","type":"array","items":{"$ref":"#/components/schemas/ChargeClassification"}},"disclosure":{"type":"string","description":"Disclosure notice regarding the classifications, in markdown format"}},"required":["data","classifications","disclosure"]},"GetCredentialResponse":{"type":"object","properties":{"id":{"type":"string","description":"The id of the Credential"},"name":{"type":"string","description":"The name of the Credential"},"createdAt":{"format":"date-time","type":"string","description":"The creation date of the Credential"},"typeId":{"type":"string","description":"The id of the credential type used to create the credential"},"userId":{"type":"string","description":"The id of the user the credential was issued to"},"organizationId":{"type":"string","description":"The id of the organization that issued the credential"},"data":{"type":"object","description":"The raw credential data","additionalProperties":true},"status":{"type":"object","description":"The status of the credential. One of \"PENDING\", \"ACTIVE\" or \"REVOKED\"","example":{"value":"ACTIVE"},"required":["value"],"properties":{"value":{"type":"string","description":"PENDING, ACTIVE or REVOKED.","example":"ACTIVE"}}}},"required":["id","name","createdAt","typeId","userId","organizationId","data","status"]},"GetCredentialTypeResponse":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"slug":{"type":"string"},"version":{"type":"string"},"createdAt":{"format":"date-time","type":"string"},"schema":{"type":"object","additionalProperties":true},"organizationId":{"type":"string","nullable":true},"beam":{"$ref":"#/components/schemas/Beam"}},"required":["id","name","slug","version","createdAt","schema","organizationId","beam"]},"GetRecommendedSearchCountiesResponse":{"type":"object","properties":{"recommendedSearchCounties":{"description":"Recommended county searches derived from result statusMeta","type":"array","items":{"$ref":"#/components/schemas/RecommendedSearchCountyResponse"}},"disclosure":{"type":"string","description":"Disclosure notice regarding the recommended county searches, in markdown format"}},"required":["recommendedSearchCounties","disclosure"]},"GetVIDInviteStatusResponse":{"type":"object","properties":{"inviteId":{"type":"string","description":"The ID of the invite","example":"81eb7401-8ff0-4404-8450-4d7508482c19"},"status":{"type":"string","description":"The status of the invite","enum":["PENDING","STARTED","COMPLETE","ACCEPTED","CANCELED","OPT_OUT"],"example":"PENDING"},"orderId":{"type":"string","nullable":true,"format":"uuid","description":"ID of the order created from this invite. Always present; null until the applicant submits an order.","example":"0bb0f6f8-459f-482a-952e-7caf029517f6"},"order":{"description":"Summary of the order created from this invite. Omitted until the order exists.","allOf":[{"$ref":"#/components/schemas/InviteOrderPayload"}]}},"required":["inviteId","status","orderId"]},"GetVIDInvitesResponse":{"type":"object","properties":{"invites":{"description":"Array of invite responses","type":"array","items":{"$ref":"#/components/schemas/vIDListInviteResponse"}},"meta":{"$ref":"#/components/schemas/PaginationMetaResponse"},"links":{"$ref":"#/components/schemas/PaginationLinksResponse"}},"required":["invites","meta","links"]},"GetWalletConfigurationResponse":{"type":"object","properties":{"passTypes":{"type":"array","items":{"$ref":"#/components/schemas/WalletConfigurationPassTypeResponse"}}},"required":["passTypes"]},"GetWalletCredentialResponse":{"type":"object","properties":{"id":{"type":"string"},"createdAt":{"format":"date-time","type":"string"},"status":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/CredentialStatusEnum"}]},"data":{"type":"object","additionalProperties":true,"example":{}},"organization":{"nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/WalletUserCredentialOrganizationResponse"}]},"passId":{"type":"string","nullable":true},"passType":{"nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/WalletUserCredentialPassTypeResponse"}]},"beam":{"nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/WalletUserCredentialBeamResponse"}]},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/WalletUserCredentialAttachmentResponse"}}},"required":["id","createdAt","data","organization","passType","beam","attachments"]},"GetWalletUserCredentialsResponse":{"type":"object","properties":{"userId":{"type":"string"},"credentials":{"type":"array","items":{"$ref":"#/components/schemas/WalletUserCredentialResponse"}}},"required":["userId","credentials"]},"IdCardRotationEnum":{"type":"string","enum":["ZERO","CLOCKWISE_90","COUNTER_CLOCKWISE_90","UPSIDE_DOWN"]},"IdScanData":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/IdScanDataName"},"gender":{"type":"string"},"dateOfBirth":{"type":"string"},"address":{"$ref":"#/components/schemas/IdScanDataAddress"},"documentSpecificData":{"$ref":"#/components/schemas/DocumentSpecificData"}},"required":["gender","dateOfBirth","address","documentSpecificData"]},"IdScanDataAddress":{"type":"object","properties":{"addressLineOne":{"type":"string"},"addressLineTwo":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"postalCode":{"type":"string"},"country":{"type":"string"}},"required":["addressLineOne","city","state","postalCode","country"]},"IdScanDataName":{"type":"object","properties":{"firstName":{"type":"string"},"middleName":{"type":"string"},"lastName":{"type":"string"},"suffix":{"type":"string"}},"required":["firstName","middleName","lastName","suffix"]},"IdVerificationData":{"type":"object","properties":{"idScanBiometricMatch":{"type":"boolean"},"idScanData":{"$ref":"#/components/schemas/IdScanData"},"applicantAliasData":{"$ref":"#/components/schemas/ApplicantAliasData"}},"required":["idScanBiometricMatch","idScanData","applicantAliasData"]},"IdVerificationModelEnum":{"type":"string","enum":["MERLIN","REMUS"]},"IdVerificationResultCheckEnum":{"type":"string","enum":["PASS","FAIL"]},"InternalServerError":{"type":"object","properties":{"name":{"type":"string","default":"INTERNAL_SERVER_ERROR"},"code":{"type":"number","default":500},"message":{"type":"string","example":"service error"}},"required":["name","code","message"]},"InviteOrderPayload":{"type":"object","properties":{"id":{"type":"string","description":"ID of an order"},"backgroundReportUrl":{"type":"string","description":"Report URL of completed order"},"additionalMetadata":{"type":"object","description":"Always an empty object in this response. Retrieve the order with Get Order Details to read its additionalMetadata.","additionalProperties":true,"example":{}},"status":{"type":"string","description":"Status of an order","enum":["PENDING","IN_PROGRESS","IN_DISPUTE","COMPLETE","INCOMPLETE",null],"nullable":true},"score":{"type":"string","nullable":true,"enum":["CLIENT_REVIEW","NO_ALERTS","ON_HOLD","ADVERSE_ACTION","REVIEW_REQUIRED","WITHDRAWN","ID_VERIFIED","ID_NOT_VERIFIED","ALERTS_FOUND","PENDING","PRE_ADVERSE","NO_DRUG_TEST","SCREENING_CLEAR","SCREENING_ALERT","SCREENING_NO_ALERT","SCREENING_PENDING","REVIEW_PASS",null],"description":"Order score, or null when not scored."},"alert":{"type":"string","description":"Alert of an order","enum":["ALERTS_FOUND","NO_ALERTS_FOUND",null],"nullable":true},"createdAt":{"type":"string","description":"Creation date of an order","format":"date-time"},"updatedAt":{"type":"string","description":"Last update date of an order","format":"date-time"}},"required":["id","backgroundReportUrl","additionalMetadata","createdAt","updatedAt"]},"IpAddressDetails":{"type":"object","properties":{"ipAddress":{"type":"string","example":"203.0.113.42"},"location":{"nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/IpLocation"}]},"checks":{"nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/IpRiskChecks"}]},"network":{"nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/IpNetwork"}]},"corporateProxy":{"nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/CorporateProxyDetails"}]},"abuseRiskScore":{"type":"number","nullable":true,"example":0.0123}},"required":["ipAddress","location","checks","network","corporateProxy","abuseRiskScore"]},"IpLocation":{"type":"object","properties":{"city":{"type":"string","example":"Atlanta"},"state":{"type":"string","example":"Georgia"},"postalCode":{"type":"string","example":"30303"},"country":{"type":"string","example":"United States"},"countryCode":{"type":"string","example":"US"}},"required":["city","state","postalCode","country","countryCode"]},"IpNetwork":{"type":"object","properties":{"mobile":{"type":"boolean","example":false},"datacenter":{"type":"boolean","example":true}},"required":["mobile","datacenter"]},"IpRiskChecks":{"type":"object","properties":{"validIp":{"type":"string","enum":["PASS","ALERT"],"example":"PASS"},"crawler":{"type":"string","enum":["PASS","ALERT"],"example":"PASS"},"tor":{"type":"string","enum":["PASS","ALERT"],"example":"PASS"},"proxyOrVpn":{"type":"string","enum":["PASS","ALERT"],"example":"ALERT"},"abusive":{"type":"string","enum":["PASS","ALERT"],"example":"PASS"}},"required":["validIp","crawler","tor","proxyOrVpn","abusive"]},"ListPackageSetsResponse":{"type":"object","properties":{"packageSets":{"type":"array","items":{"$ref":"#/components/schemas/PackageSetListItem"}}},"required":["packageSets"]},"MonitoringReportDetailResponse":{"type":"object","properties":{"id":{"type":"string","description":"Monitoring report ID","example":"MOR-0bb0f6f8459f"},"orderId":{"type":"string","description":"Order ID associated with the monitoring enrollment","example":"ORD-1cc1f7f956a0"},"enrollmentId":{"type":"string","description":"Monitoring enrollment ID","example":"MOE-9d3e5f7a8b2c"},"cycleId":{"type":"string","description":"Monitoring cycle ID","example":"MCY-2ee2a8ba67b1"},"createdAt":{"format":"date-time","type":"string","description":"Timestamp when the monitoring report was created","example":"2026-07-15T10:00:00.000Z"},"updatedAt":{"format":"date-time","type":"string","description":"Timestamp when the monitoring report was last updated","example":"2026-07-15T10:05:00.000Z"},"reviewedAt":{"format":"date-time","type":"string","description":"Timestamp when the monitoring report was reviewed","example":"2026-07-15T10:04:00.000Z","nullable":true},"reviewStatus":{"type":"string","description":"Current monitoring report review status","enum":["PENDING","IN_PROGRESS","CONFIRMATION_REQUESTED","CONFIRMATION_RECEIVED","COMPLETED"],"example":"COMPLETED"},"score":{"type":"string","description":"Score assigned to the monitoring report","enum":["REVIEW_REQUIRED","NO_ALERTS_FOUND","ALERTS_FOUND"],"example":"NO_ALERTS_FOUND","nullable":true},"customScore":{"type":"string","description":"Custom score assigned during monitoring review","example":"eligible","nullable":true},"pdfUrl":{"type":"string","description":"Signed URL for the latest monitoring report PDF, when available","nullable":true}},"required":["id","orderId","enrollmentId","cycleId","createdAt","updatedAt","reviewedAt","reviewStatus","score","customScore","pdfUrl"]},"MonitoringReportListItemResponse":{"type":"object","properties":{"id":{"type":"string","description":"Monitoring report ID","example":"MOR-0bb0f6f8459f"},"orderId":{"type":"string","description":"Order ID associated with the monitoring enrollment","example":"ORD-1cc1f7f956a0"},"enrollmentId":{"type":"string","description":"Monitoring enrollment ID","example":"MOE-9d3e5f7a8b2c"},"cycleId":{"type":"string","description":"Monitoring cycle ID","example":"MCY-2ee2a8ba67b1"},"createdAt":{"format":"date-time","type":"string","description":"Timestamp when the monitoring report was created","example":"2026-07-15T10:00:00.000Z"},"updatedAt":{"format":"date-time","type":"string","description":"Timestamp when the monitoring report was last updated","example":"2026-07-15T10:05:00.000Z"},"reviewedAt":{"format":"date-time","type":"string","description":"Timestamp when the monitoring report was reviewed","example":"2026-07-15T10:04:00.000Z","nullable":true},"reviewStatus":{"type":"string","description":"Current monitoring report review status","enum":["PENDING","IN_PROGRESS","CONFIRMATION_REQUESTED","CONFIRMATION_RECEIVED","COMPLETED"],"example":"COMPLETED"},"score":{"type":"string","description":"Score assigned to the monitoring report","enum":["REVIEW_REQUIRED","NO_ALERTS_FOUND","ALERTS_FOUND"],"example":"NO_ALERTS_FOUND","nullable":true},"customScore":{"type":"string","description":"Custom score assigned during monitoring review","example":"eligible","nullable":true},"pdfUrl":{"type":"string","description":"Signed URL for the latest monitoring report PDF"}},"required":["id","orderId","enrollmentId","cycleId","createdAt","updatedAt","reviewedAt","reviewStatus","score","customScore","pdfUrl"]},"MonitoringReportListResponse":{"type":"object","properties":{"data":{"description":"Monitoring reports with attached PDFs representing reportable results","type":"array","items":{"$ref":"#/components/schemas/MonitoringReportListItemResponse"}}},"required":["data"]},"NotFoundError":{"type":"object","properties":{"name":{"type":"string","default":"NOT_FOUND"},"code":{"type":"number","default":404},"message":{"type":"string","example":"Not Found"}},"required":["name","code","message"]},"Order":{"type":"object","properties":{"id":{"type":"string","description":"order id","example":"0bb0f6f8-459f-482a-952e-7caf029517f6"},"monitoringEnrollmentId":{"type":"string","description":"ID of the latest monitoring enrollment for this order. Omitted when there is none.","example":"6c2e8a4f-1b3d-4f5a-9e7c-2a4b6d8f0e13","format":"uuid"},"backgroundReportUrl":{"type":"string","description":"this is report url of completed order","example":"https://cognition.cerebrum.com/order/81eb7401-8ff0-4404-8450-4d7508482c19"},"reportDisputeUrl":{"type":"string","description":"Dispute Center URL for viewing the background report and submitting a dispute. This may be null if an email address or organization shortName is not available for the order.","nullable":true,"example":"https://cognition.cerebrum.com/dispute/acme/auth/0bb0f6f8-459f-482a-952e-7caf029517f6?email=applicant%40example.com"},"disputeResolution":{"description":"Latest dispute resolution summary for the order, including the order changes captured when the dispute resolution completed.","allOf":[{"$ref":"#/components/schemas/OrderDisputeResolution"}]},"status":{"type":"string","description":"Workflow status. An order without a stored status is returned as PENDING. New values may be added; treat unknown values as not complete.","enum":["PENDING","IN_PROGRESS","IN_DISPUTE","COMPLETE","INCOMPLETE"],"example":"COMPLETE"},"score":{"type":"string","description":"Order score as the same enum value accepted by Update Order, or null when not scored. New values may be added.","nullable":true,"example":"ID_VERIFIED","enum":["CLIENT_REVIEW","NO_ALERTS","ON_HOLD","ADVERSE_ACTION","REVIEW_REQUIRED","WITHDRAWN","ID_VERIFIED","ID_NOT_VERIFIED","ALERTS_FOUND","PENDING","PRE_ADVERSE","NO_DRUG_TEST","SCREENING_CLEAR","SCREENING_ALERT","SCREENING_NO_ALERT","SCREENING_PENDING","REVIEW_PASS",null]},"customScore":{"type":"string","description":"Free-text custom score set by your organization, or null.","nullable":true,"example":"Alert-3"},"alert":{"type":"string","enum":["ALERTS_FOUND","NO_ALERTS_FOUND",null],"nullable":true,"example":"NO_ALERTS_FOUND"},"additionalMetadata":{"type":"object","description":"this will be the same json object which was passed when creating order","example":{}},"selfieUrl":{"type":"string"},"orderDeliveryType":{"type":"string","description":"Order delivery method","enum":["rapidRequest","vidScreen","standard","vIDWeb"],"example":"vidScreen"},"idVerificationData":{"description":"Verified ID information. Included when the order has an ID verification result and `expand` contains `id_verification_data` (or the legacy alias `idVerificationData`).","example":{"idScanBiometricMatch":true,"idScanData":{"name":{"firstName":"Eliane","middleName":"Elliott","lastName":"Friesen","suffix":"III"},"gender":"male","dateOfBirth":"1990-10-28","address":{"addressLineOne":"2558 Kirlin Centers","addressLineTwo":"","city":"Savannaburgh","state":"ID","postalCode":"90176-5365","country":"US"},"documentSpecificData":{"type":"StateIdentificationCard","number":"369-57-4649","expiryDate":"2023-04-17T18:19:11.196Z","issueDate":"2023-04-17T18:19:11.196Z"}},"applicantAliasData":{"names":[{"firstName":"Wilburn","middleName":"Ryan","lastName":"Keeling","suffix":"DDS","nameType":"primary"}],"addresses":[{"addressLineOne":"85557 Douglas Landing","addressLineTwo":"","city":"South Bo","state":"NE","postalCode":"54069-8169","country":"US","addressType":"primary"}],"socialSecurityNumber":"369-57-4649"}},"allOf":[{"$ref":"#/components/schemas/IdVerificationData"}]},"ipAddressDetails":{"description":"The submission IP address, derived location, and associated checks. Included when the \"expand\" query parameter contains \"ip_address_details\".","nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/IpAddressDetails"}]},"reportableResults":{"type":"object","description":"The reportable results information will be included in the response when the order has backgroud verification results attached and the \"expand\" query parameter contains \"reportable_results\" as an array element."},"createdAt":{"format":"date-time","type":"string"},"updatedAt":{"format":"date-time","type":"string"},"reportCompletedAt":{"type":"string","nullable":true,"format":"date-time"},"applicantContactDetails":{"nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/ContactDetails"}]},"signedDisclosurePdf":{"type":"string"},"backgroundReportPdf":{"type":"string"},"vIDReportPdf":{"type":"string"},"verificationCheckResults":{"$ref":"#/components/schemas/VerificationCheckResults"},"credentials":{"type":"array","items":{"$ref":"#/components/schemas/GetCredentialResponse"}}},"required":["id","backgroundReportUrl","status","score","customScore","alert","additionalMetadata","orderDeliveryType","createdAt","updatedAt","applicantContactDetails"]},"OrderApplicantDataResponse":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/CriminalCaseSchemaName"},"aliases":{"type":"array","items":{"$ref":"#/components/schemas/CriminalCaseSchemaName"}},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/CriminalCaseSchemaAddress"}},"socialSecurityNumber":{"type":"string","nullable":true},"dateOfBirth":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"phoneNumber":{"type":"string","nullable":true}},"required":["name","aliases","addresses"]},"OrderDisputeResolution":{"type":"object","properties":{"disputeId":{"type":"string","description":"ID of the dispute whose resolution completed the order.","example":"9d3e5f7a-8b2c-4a1e-9f6d-7c8b5a4e3d2f"},"resolvedAt":{"type":"string","description":"Timestamp when the dispute was resolved.","example":"2026-02-16T10:30:00.000Z"},"outcome":{"type":"string","description":"The explicit outcome selected when resolving the dispute.","enum":["RESULTS_CHANGED","RESULTS_UNCHANGED"]},"changes":{"description":"Order changes captured when the dispute resolution completed.","type":"array","items":{"$ref":"#/components/schemas/OrderDisputeResolutionChange"}}},"required":["disputeId","resolvedAt","changes"]},"OrderDisputeResolutionChange":{"type":"object","properties":{"op":{"type":"string","enum":["add","remove","replace","move","copy","test"],"example":"replace"},"path":{"type":"string","description":"JSON Pointer path for the changed order field.","example":"/status"},"before":{"type":"object","description":"Value before the dispute resolution.","nullable":true},"after":{"type":"object","description":"Value after the dispute resolution.","nullable":true}},"required":["op","path"]},"OrderRequestedSearch":{"type":"object","properties":{"id":{"type":"string"},"orderId":{"type":"string"},"status":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"searchType":{"$ref":"#/components/schemas/OrderSearchTypeInfo"},"request":{"$ref":"#/components/schemas/OrderSearchRequest"}},"required":["id","orderId","status","createdAt","updatedAt","searchType","request"]},"OrderRequestedSearchExpanded":{"type":"object","properties":{"id":{"type":"string"},"orderId":{"type":"string"},"status":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"searchType":{"$ref":"#/components/schemas/OrderSearchTypeInfo"},"request":{"$ref":"#/components/schemas/OrderSearchRequest"},"results":{"type":"array","items":{"$ref":"#/components/schemas/OrderSearchResult"}}},"required":["id","orderId","status","createdAt","updatedAt","searchType","request","results"]},"OrderSearchRequest":{"type":"object","properties":{"type":{"type":"string"},"county":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"fipsCode":{"type":"string","nullable":true}},"required":["type"]},"OrderSearchResult":{"type":"object","properties":{"id":{"type":"string"},"requestedSearchId":{"type":"string","nullable":true},"blob":{"type":"object"},"normalized":{"type":"object"},"searchType":{"type":"string","nullable":true},"alert":{"type":"string","nullable":true},"status":{"type":"string","description":"Lifecycle status of the result","enum":["PENDING","COMPLETE","INCOMPLETE"]},"statusMeta":{"type":"object","nullable":true},"detail":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"vendor":{"$ref":"#/components/schemas/OrderSearchResultVendor"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/OrderSearchResultAttachment"}}},"required":["id","status","detail","createdAt","updatedAt","attachments"]},"OrderSearchResultAttachment":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string","nullable":true}},"required":["id","name"]},"OrderSearchResultVendor":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"email":{"type":"string"}},"required":["id","name","email"]},"OrderSearchTypeInfo":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"OrderSearchesResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/OrderRequestedSearch"}}},"required":["data"]},"OrdersResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Order"}},"meta":{"description":"Pagination metadata for the current response","allOf":[{"$ref":"#/components/schemas/PaginationMetaResponse"}]},"links":{"description":"Pagination links for the current response","allOf":[{"$ref":"#/components/schemas/PaginationLinksResponse"}]}},"required":["data","meta","links"]},"OrgRelationTypeEnum":{"type":"string","enum":["CRA","PARENT"]},"OrganizationLifecycleStatusEnum":{"type":"string","enum":["ACTIVE","INACTIVE"]},"OrganizationResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/OrganizationSummaryResponse"}},"required":["data"]},"OrganizationSummaryResponse":{"type":"object","properties":{"lifecycleStatus":{"allOf":[{"$ref":"#/components/schemas/OrganizationLifecycleStatusEnum"}]},"id":{"type":"string"},"name":{"type":"string"},"shortName":{"type":"string"},"delegateWebhooksToCra":{"type":"boolean"},"metadata":{"type":"object","additionalProperties":true,"nullable":true},"createdAt":{"format":"date-time","type":"string"},"updatedAt":{"format":"date-time","type":"string"}},"required":["lifecycleStatus","id","name","shortName","delegateWebhooksToCra","createdAt","updatedAt"]},"OrganizationsResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/OrganizationSummaryResponse"}},"meta":{"$ref":"#/components/schemas/PaginationMetaResponse"},"links":{"$ref":"#/components/schemas/PaginationLinksResponse"}},"required":["data","meta","links"]},"PackageSetListItem":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"shortName":{"type":"string"},"description":{"type":"string","nullable":true},"amount":{"type":"number"},"currency":{"allOf":[{"$ref":"#/components/schemas/CurrencyTypeEnum"}]},"amountPrecision":{"allOf":[{"$ref":"#/components/schemas/CurrencyMultiplierEnum"}]},"isActive":{"type":"boolean"},"organizationId":{"type":"string","nullable":true,"description":"ID of the organization that owns the package. List Package Sets returns only packages that have an owner."}},"required":["id","name","shortName","description","amount","currency","amountPrecision","isActive","organizationId"]},"PaginationLinksResponse":{"type":"object","properties":{"self":{"type":"string","description":"Path and query of this page, relative to the API host. Your filters are kept; limit and offset are set."},"next":{"type":"string","description":"Path and query of the next page, or null on the last page.","nullable":true},"prev":{"type":"string","description":"Path and query of the previous page, or null on the first page.","nullable":true}},"required":["self","next","prev"]},"PaginationMetaResponse":{"type":"object","properties":{"limit":{"type":"integer","description":"Page size used for this response. Defaults differ by endpoint (see its limit parameter).","example":10,"minimum":1,"maximum":30},"offset":{"type":"integer","description":"Number of records skipped before this response","example":0,"minimum":0},"total":{"type":"integer","description":"Total number of matching records","example":25,"minimum":0}},"required":["limit","offset","total"]},"RecommendedSearchCountyResponse":{"type":"object","properties":{"countyName":{"type":"string","description":"Recommended county name"},"stateCode":{"type":"string","nullable":true,"description":"Recommended county state code, when available"},"countyFips":{"type":"string","nullable":true,"description":"Recommended county FIPS code, when available"}},"required":["countyName","stateCode","countyFips"]},"RequestMonitoringDisenrollmentRequest":{"type":"object","properties":{"source":{"type":"string","description":"Source that triggered disenrollment","enum":["CLIENT_REQUEST","AUTO_DISQUALIFICATION","PRODUCT_EXPIRATION","MANUAL_OVERRIDE","LEGAL_REQUIREMENT"],"example":"CLIENT_REQUEST"},"reason":{"type":"string","description":"Optional reason for disenrollment","example":"Client requested stop monitoring"}}},"RequestMonitoringDisenrollmentResponse":{"type":"object","properties":{"orderId":{"type":"string","description":"Order ID used for disenrollment request","example":"0bb0f6f8-459f-482a-952e-7caf029517f6"},"enrollmentId":{"type":"string","description":"Monitoring enrollment ID that was processed","example":"9d3e5f7a-8b2c-4a1e-9f6d-7c8b5a4e3d2f"}},"required":["orderId","enrollmentId"]},"RequestMonitoringEnrollmentResponse":{"type":"object","properties":{"orderId":{"type":"string","description":"Order ID used for enrollment request","example":"0bb0f6f8-459f-482a-952e-7caf029517f6"},"enrollmentId":{"type":"string","description":"Monitoring enrollment ID returned for this order","example":"9d3e5f7a-8b2c-4a1e-9f6d-7c8b5a4e3d2f"},"message":{"type":"string","description":"Result message indicating whether enrollment was created or already existed","example":"Monitoring enrollment already exists for this orderId"}},"required":["orderId","enrollmentId","message"]},"SendAdverseActionNoticeResponse":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}},"required":["success","message"]},"SimulateWebhookRequest":{"type":"object","properties":{"id":{"type":"string","example":"0bb0f6f8-459f-482a-952e-7caf029517f6","description":"The dummy ID of the entity (order, invite, beamInput, or report)"},"event":{"type":"string","enum":["ORDER_STATUS_CHANGE","ORDER_SCORE_CHANGE","ORDER_CUSTOM_SCORE_CHANGE","ORDER_DISPUTE_RESOLVED","ORDER_ERROR","VOUCHER_REDEEMED","VOUCHER_ACCEPTED","VOUCHER_STARTED","VOUCHER_CANCELED","VOUCHER_EXPIRED","VOUCHER_OPTED_OUT","BEAM_INPUT_CREATED","MONITORING_REPORT_GENERATED"],"description":"The event type to trigger.","default":"ORDER_STATUS_CHANGE"},"postbackWebhookUrl":{"type":"string","example":"https://example.com/webhook-endpoint"},"additionalMetadata":{"type":"object","description":"Optional additional metadata to include in the webhook payload","example":{"customField":"value"}}},"required":["id","postbackWebhookUrl"]},"StandardOrderRequest":{"type":"object","properties":{"packageId":{"type":"string","description":"package id which will get associated to order","example":"81eb7401-8ff0-4404-8450-4d7508482c19"},"organizationId":{"type":"string","description":"The ID of the organization for the order. If not provided, the package set organization is used; if the package set has no organization, the request context organization is used.","example":"a3f1c9d2-6b4e-4c8a-b7e5-2d9f0e1a3c47","nullable":true},"postbackWebhookUrl":{"type":"string","description":"This will be the url where you want to get notified when order gets completed","example":"https://api.cerebrum.com/order-webhook"},"additionalMetadata":{"type":"object","description":"this will give ability to store any valid json which can be refer back in future when needed","example":{"clientReferenceId":"123","any_key":"value"}},"applicantData":{"description":"applicant data contains names, addresses, email, phone & mvr details","example":{"names":[{"firstName":"John","middleName":"M","lastName":"Doe","suffix":"JR","nameType":"primary"}],"dateOfBirth":"1990-10-25","socialSecurityNumber":"123-45-6789","hasSSN":true,"addresses":[{"firstLine":"One Apple Park Way","secondLine":"","city":"Cupertino","state":"CA","zipCode":"95014","country":"US","addressType":"primary"}],"contactInformation":{"email":"johndoe@gmail.com","phoneNumber":"2087444184"}},"allOf":[{"$ref":"#/components/schemas/CustomApplicantDataType"}]}},"required":["packageId","additionalMetadata","applicantData"]},"StandardOrderResponse":{"type":"object","properties":{"orderId":{"type":"string","description":"id of newly created order"},"additionalMetadata":{"type":"object","description":"this will be the same json object which was passed when creating order"}},"required":["orderId","additionalMetadata"]},"SubmitDisputeRequest":{"type":"object","properties":{"orderId":{"type":"string","description":"The order ID that the dispute is related to","example":"0bb0f6f8-459f-482a-952e-7caf029517f6"},"specificItem":{"type":"string","description":"A reference to a particular item in the report that is being disputed","nullable":true,"example":"Criminal record from 2015 in Los Angeles County"},"reason":{"type":"string","description":"The reason for the dispute","enum":["DISMISSED_OR_EXPUNGED","INACCURATE_RECORDS","NOT_MY_RECORDS","INACCURATE_INFORMATION","NOT_MY_INFORMATION","CLARIFICATION_ON_CRIMINAL_RECORDS","CLARIFICATION_ON_INFORMATION","VICTIM_OF_HUMAN_TRAFFICKING","OTHER"],"example":"INACCURATE_RECORDS"},"description":{"type":"string","description":"Additional details about the dispute","nullable":true,"example":"The record shows an incorrect conviction date"}},"required":["orderId","reason"]},"SubmitDisputeResponse":{"type":"object","properties":{"disputeId":{"type":"string","description":"The ID of the newly created dispute","example":"9d3e5f7a-8b2c-4a1e-9f6d-7c8b5a4e3d2f"},"status":{"type":"string","description":"The status of the dispute","enum":["OPEN","IN_PROGRESS","RESOLVED"],"example":"OPEN"},"createdAt":{"format":"date-time","type":"string","description":"Timestamp when the dispute was created","example":"2026-02-16T10:30:00.000Z"}},"required":["disputeId","status","createdAt"]},"SuccessResponse":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["success"]},"TazworksApplicant":{"type":"object","properties":{"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phoneNumber":{"type":"string"},"proposedPosition":{"type":"string"},"proposedSalary":{"type":"string"},"monthlyIncome":{"type":"number"},"monthlyDebt":{"type":"number"},"monthlyRent":{"type":"number"},"desiredUnit":{"type":"string"},"referredBy":{"type":"string"},"jobLocation":{"type":"string"},"stateOfEmployment":{"type":"string"},"countyOfEmployment":{"type":"string"},"cityOfEmployment":{"type":"string"}},"required":["firstName","lastName","email"]},"TazworksCustomSearch":{"type":"object","properties":{"type":{"type":"string"},"customSearchGuid":{"type":"string"}},"required":["type","customSearchGuid"]},"TazworksNativeOrderRequest":{"type":"object","properties":{"clientGuid":{"type":"string"},"productGuid":{"type":"string"},"vidPackage":{"type":"string"},"applicant":{"$ref":"#/components/schemas/TazworksApplicant"},"orderDetail":{"$ref":"#/components/schemas/TazworksOrderDetail"},"optionalCustomSearches":{"type":"array","items":{"$ref":"#/components/schemas/TazworksCustomSearch"}}},"required":["clientGuid","productGuid","vidPackage","applicant"]},"TazworksOccupationalHealthData":{"type":"object","properties":{"panels":{"type":"array","items":{"$ref":"#/components/schemas/TazworksOccupationalHealthPanel"}}}},"TazworksOccupationalHealthPanel":{"type":"object","properties":{"panelGuid":{"type":"string"}},"required":["panelGuid"]},"TazworksOrderDetail":{"type":"object","properties":{"occupationalHealthData":{"$ref":"#/components/schemas/TazworksOccupationalHealthData"},"clientProductGuid":{"type":"string"},"certifyPermissiblePurpose":{"type":"boolean"},"generalReportReference":{"type":"string"},"externalIdentifier":{"type":"string"},"requestingUserGuid":{"type":"string"},"billable":{"type":"string"},"costCode":{"type":"string"},"orderNotes":{"type":"string"},"customFields":{"type":"object","additionalProperties":true},"optionalSearches":{"type":"array","items":{"type":"string"}},"specifiedVendors":{"type":"object","additionalProperties":true,"nullable":true}}},"TazworksResultAcceptedResponse":{"type":"object","properties":{"accepted":{"type":"boolean","example":true}},"required":["accepted"]},"TazworksResultRequest":{"type":"object","properties":{"tazworksOrderId":{"type":"string"},"packageName":{"type":"string"},"craName":{"type":"string"},"orderStatus":{"type":"string"},"reportDecision":{"type":"string","nullable":true},"score":{"type":"string","enum":["CLIENT_REVIEW","NO_ALERTS","ON_HOLD","ADVERSE_ACTION","REVIEW_REQUIRED","WITHDRAWN","ID_VERIFIED","ID_NOT_VERIFIED","ALERTS_FOUND","PENDING","PRE_ADVERSE","NO_DRUG_TEST","SCREENING_CLEAR","SCREENING_ALERT","SCREENING_NO_ALERT","SCREENING_PENDING","REVIEW_PASS"],"description":"Cortex order score derived from the TazWorks decision."},"customScore":{"type":"string","description":"Cortex custom score derived from the TazWorks decision."},"completedDate":{"type":"number","description":"TazWorks completion timestamp in milliseconds since epoch. Required when orderStatus is complete."},"backgroundReportUrl":{"type":"string","description":"TazWorks background report PDF URL. Required when orderStatus is complete. Must be a valid URL."}},"required":["tazworksOrderId","packageName","craName","orderStatus","score"]},"TooManyRequestsError":{"type":"object","properties":{"name":{"type":"string","default":"TOO_MANY_REQUESTS"},"code":{"type":"number","default":429},"message":{"type":"string","example":"Too many requests"}},"required":["name","code","message"]},"UnauthorizedError":{"type":"object","properties":{"name":{"type":"string","default":"UNAUTHORIZED_ERROR"},"code":{"type":"number","default":401},"message":{"type":"string","example":"You are not authorized"}},"required":["name","code","message"]},"UpdateDisputeStatusRequest":{"type":"object","properties":{"status":{"type":"string","description":"The new status for the dispute","enum":["OPEN","IN_PROGRESS","RESOLVED"],"example":"IN_PROGRESS"},"resolutionOutcome":{"type":"string","description":"The explicit outcome when resolving the dispute","enum":["RESULTS_CHANGED","RESULTS_UNCHANGED"],"nullable":true}},"required":["status"]},"UpdateDisputeStatusResponse":{"type":"object","properties":{"disputeId":{"type":"string","description":"The ID of the dispute","example":"9d3e5f7a-8b2c-4a1e-9f6d-7c8b5a4e3d2f"},"status":{"type":"string","description":"The updated status of the dispute","enum":["OPEN","IN_PROGRESS","RESOLVED"],"example":"IN_PROGRESS"},"resolutionOutcome":{"type":"string","description":"The explicit dispute resolution outcome","enum":["RESULTS_CHANGED","RESULTS_UNCHANGED"],"nullable":true},"updatedAt":{"format":"date-time","type":"string","description":"Timestamp when the dispute was last updated","example":"2026-02-16T10:30:00.000Z"}},"required":["disputeId","status","resolutionOutcome","updatedAt"]},"UpdateOrderRequest":{"type":"object","properties":{"status":{"type":"string","description":"New status of the order","enum":["PENDING","IN_PROGRESS","IN_DISPUTE","COMPLETE","INCOMPLETE"],"example":"COMPLETE"},"score":{"type":"string","description":"New score of the order","enum":["CLIENT_REVIEW","NO_ALERTS","ON_HOLD","ADVERSE_ACTION","REVIEW_REQUIRED","WITHDRAWN","ID_VERIFIED","ID_NOT_VERIFIED","ALERTS_FOUND","PENDING","PRE_ADVERSE","NO_DRUG_TEST","SCREENING_CLEAR","SCREENING_ALERT","SCREENING_NO_ALERT","SCREENING_PENDING","REVIEW_PASS"],"example":"ID_VERIFIED"},"customScore":{"type":"string","description":"Custom score to associate with the order","nullable":true,"example":"ANYTHING"}}},"UpdateOrderResponse":{"type":"object","properties":{"id":{"type":"string","description":"Order ID"},"status":{"type":"string","description":"Current status of the order","enum":["PENDING","IN_PROGRESS","IN_DISPUTE","COMPLETE","INCOMPLETE"],"nullable":true},"score":{"type":"string","description":"Current score of the order","enum":["CLIENT_REVIEW","NO_ALERTS","ON_HOLD","ADVERSE_ACTION","REVIEW_REQUIRED","WITHDRAWN","ID_VERIFIED","ID_NOT_VERIFIED","ALERTS_FOUND","PENDING","PRE_ADVERSE","NO_DRUG_TEST","SCREENING_CLEAR","SCREENING_ALERT","SCREENING_NO_ALERT","SCREENING_PENDING","REVIEW_PASS"],"nullable":true},"customScore":{"type":"string","description":"Current custom score of the order","nullable":true}},"required":["id","status","score","customScore"]},"UpdateOrderScoreRequest":{"type":"object","properties":{"score":{"type":"string","description":"New score of the order","enum":["CLIENT_REVIEW","NO_ALERTS","ON_HOLD","ADVERSE_ACTION","REVIEW_REQUIRED","WITHDRAWN","ID_VERIFIED","ID_NOT_VERIFIED","ALERTS_FOUND","PENDING","PRE_ADVERSE","NO_DRUG_TEST","SCREENING_CLEAR","SCREENING_ALERT","SCREENING_NO_ALERT","SCREENING_PENDING","REVIEW_PASS"],"example":"NO_ALERTS"},"customScore":{"type":"string","description":"Optional custom score to associate with the order","nullable":true}},"required":["score"]},"UpdateOrderScoreResponse":{"type":"object","properties":{"id":{"type":"string","description":"order id"},"score":{"type":"string","description":"Updated score of the order","enum":["CLIENT_REVIEW","NO_ALERTS","ON_HOLD","ADVERSE_ACTION","REVIEW_REQUIRED","WITHDRAWN","ID_VERIFIED","ID_NOT_VERIFIED","ALERTS_FOUND","PENDING","PRE_ADVERSE","NO_DRUG_TEST","SCREENING_CLEAR","SCREENING_ALERT","SCREENING_NO_ALERT","SCREENING_PENDING","REVIEW_PASS"],"nullable":true},"customScore":{"type":"string","description":"Updated custom score of the order, if any","nullable":true}},"required":["id","score"]},"UpdateReportableChargesRequest":{"type":"object","properties":{"reportableCharges":{"type":"array","items":{"type":"string"}}},"required":["reportableCharges"]},"UpdateReportableChargesResponse":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"UpdateWalletCredentialStatusRequest":{"type":"object","properties":{"status":{"type":"string","enum":["ACTIVE","REVOKED"],"example":"REVOKED"}},"required":["status"]},"UpdateWalletCredentialStatusResponse":{"type":"object","properties":{"credentialId":{"type":"string"},"status":{"type":"string","enum":["ACTIVE","REVOKED"],"example":"REVOKED"}},"required":["credentialId","status"]},"UserListAddress":{"type":"object","properties":{"id":{"type":"string"},"addressLineOne":{"type":"string"},"addressLineTwo":{"type":"string","nullable":true},"city":{"type":"string"},"state":{"type":"string"},"postalCode":{"type":"string"},"country":{"type":"string"}},"required":["id","addressLineOne","city","state","postalCode","country"]},"UserListItem":{"type":"object","properties":{"id":{"type":"string"},"email":{"type":"string","nullable":true},"names":{"description":"User names","type":"array","items":{"$ref":"#/components/schemas/UserListName"}},"addresses":{"description":"User addresses","type":"array","items":{"$ref":"#/components/schemas/UserListAddress"}}},"required":["id","names","addresses"]},"UserListName":{"type":"object","properties":{"id":{"type":"string"},"firstName":{"type":"string","nullable":true},"middleName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"suffix":{"type":"string","nullable":true}},"required":["id"]},"UserListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/UserListItem"}},"meta":{"$ref":"#/components/schemas/PaginationMetaResponse"},"links":{"$ref":"#/components/schemas/PaginationLinksResponse"}},"required":["data","meta","links"]},"VerificationCheckResults":{"type":"object","properties":{"id":{"type":"string"},"createdAt":{"format":"date-time","type":"string"},"updatedAt":{"format":"date-time","type":"string"},"model":{"allOf":[{"$ref":"#/components/schemas/IdVerificationModelEnum"}]},"modelVersion":{"type":"string"},"overall":{"allOf":[{"$ref":"#/components/schemas/IdVerificationResultCheckEnum"}]},"certainty":{"type":"string"},"frontCardRotation":{"allOf":[{"$ref":"#/components/schemas/IdCardRotationEnum"}]},"backCardRotation":{"allOf":[{"$ref":"#/components/schemas/IdCardRotationEnum"}]},"dataOverall":{"allOf":[{"$ref":"#/components/schemas/IdVerificationResultCheckEnum"}]},"dataMatchOverall":{"allOf":[{"$ref":"#/components/schemas/IdVerificationResultCheckEnum"}]},"firstNameMatch":{"allOf":[{"$ref":"#/components/schemas/IdVerificationResultCheckEnum"}]},"lastNameMatch":{"allOf":[{"$ref":"#/components/schemas/IdVerificationResultCheckEnum"}]},"fullNameMatch":{"allOf":[{"$ref":"#/components/schemas/IdVerificationResultCheckEnum"}]},"addressMatch":{"allOf":[{"$ref":"#/components/schemas/IdVerificationResultCheckEnum"}]},"placeOfBirthMatch":{"allOf":[{"$ref":"#/components/schemas/IdVerificationResultCheckEnum"}]},"raceMatch":{"allOf":[{"$ref":"#/components/schemas/IdVerificationResultCheckEnum"}]},"religionMatch":{"allOf":[{"$ref":"#/components/schemas/IdVerificationResultCheckEnum"}]},"professionMatch":{"allOf":[{"$ref":"#/components/schemas/IdVerificationResultCheckEnum"}]},"maritalStatusMatch":{"allOf":[{"$ref":"#/components/schemas/IdVerificationResultCheckEnum"}]},"residentialStatusMatch":{"allOf":[{"$ref":"#/components/schemas/IdVerificationResultCheckEnum"}]},"employerMatch":{"allOf":[{"$ref":"#/components/schemas/IdVerificationResultCheckEnum"}]},"dateOfBirthMatch":{"allOf":[{"$ref":"#/components/schemas/IdVerificationResultCheckEnum"}]},"dateOfIssueMatch":{"allOf":[{"$ref":"#/components/schemas/IdVerificationResultCheckEnum"}]},"dateOfExpiryMatch":{"allOf":[{"$ref":"#/components/schemas/IdVerificationResultCheckEnum"}]},"documentNumberMatch":{"allOf":[{"$ref":"#/components/schemas/IdVerificationResultCheckEnum"}]},"personalIdNumberMatch":{"allOf":[{"$ref":"#/components/schemas/IdVerificationResultCheckEnum"}]},"documentAdditionalNumberMatch":{"allOf":[{"$ref":"#/components/schemas/IdVerificationResultCheckEnum"}]},"documentOptionalAdditionalNumberMatch":{"allOf":[{"$ref":"#/components/schemas/IdVerificationResultCheckEnum"}]},"dataLogicOverall":{"allOf":[{"$ref":"#/components/schemas/IdVerificationResultCheckEnum"}]},"dataLogicDateOverall":{"allOf":[{"$ref":"#/components/schemas/IdVerificationResultCheckEnum"}]},"dateOfBirthBeforeDateOfIssueCheck":{"allOf":[{"$ref":"#/components/schemas/IdVerificationResultCheckEnum"}]},"dateOfBirthBeforeDateOfExpiryCheck":{"allOf":[{"$ref":"#/components/schemas/IdVerificationResultCheckEnum"}]},"dateOfIssueBeforeDateOfExpiryCheck":{"allOf":[{"$ref":"#/components/schemas/IdVerificationResultCheckEnum"}]},"dateOfBirthInPastCheck":{"allOf":[{"$ref":"#/components/schemas/IdVerificationResultCheckEnum"}]},"dateOfIssueInPastCheck":{"allOf":[{"$ref":"#/components/schemas/IdVerificationResultCheckEnum"}]},"dataLogicMRZOverall":{"allOf":[{"$ref":"#/components/schemas/IdVerificationResultCheckEnum"}]},"mrzParsed":{"allOf":[{"$ref":"#/components/schemas/IdVerificationResultCheckEnum"}]},"mrzCheckDigits":{"allOf":[{"$ref":"#/components/schemas/IdVerificationResultCheckEnum"}]},"dataLogicDocumentNumber":{"allOf":[{"$ref":"#/components/schemas/IdVerificationResultCheckEnum"}]},"dataLogicPersonalIdNumber":{"allOf":[{"$ref":"#/components/schemas/IdVerificationResultCheckEnum"}]},"dataFormatOverall":{"allOf":[{"$ref":"#/components/schemas/IdVerificationResultCheckEnum"}]},"dateOfBirthFormat":{"allOf":[{"$ref":"#/components/schemas/IdVerificationResultCheckEnum"}]},"dateOfExpiryFormat":{"allOf":[{"$ref":"#/components/schemas/IdVerificationResultCheckEnum"}]},"dateOfIssueFormat":{"allOf":[{"$ref":"#/components/schemas/IdVerificationResultCheckEnum"}]},"documentNumberFormat":{"allOf":[{"$ref":"#/components/schemas/IdVerificationResultCheckEnum"}]},"documentAdditionalNumberFormat":{"allOf":[{"$ref":"#/components/schemas/IdVerificationResultCheckEnum"}]},"documentOptionalAdditionalNumberFormat":{"allOf":[{"$ref":"#/components/schemas/IdVerificationResultCheckEnum"}]},"personalIdNumberFormat":{"allOf":[{"$ref":"#/components/schemas/IdVerificationResultCheckEnum"}]},"additionalPersonalIdNumberFormat":{"allOf":[{"$ref":"#/components/schemas/IdVerificationResultCheckEnum"}]},"sexFormat":{"allOf":[{"$ref":"#/components/schemas/IdVerificationResultCheckEnum"}]},"nationalityFormat":{"allOf":[{"$ref":"#/components/schemas/IdVerificationResultCheckEnum"}]},"issueAuthorityFormat":{"allOf":[{"$ref":"#/components/schemas/IdVerificationResultCheckEnum"}]},"maritalStatusFormat":{"allOf":[{"$ref":"#/components/schemas/IdVerificationResultCheckEnum"}]},"religionFormat":{"allOf":[{"$ref":"#/components/schemas/IdVerificationResultCheckEnum"}]},"classEfectiveDateFormat":{"allOf":[{"$ref":"#/components/schemas/IdVerificationResultCheckEnum"}]},"classExpiryDateFormat":{"allOf":[{"$ref":"#/components/schemas/IdVerificationResultCheckEnum"}]},"dataBarcodeAnomalyOverall":{"allOf":[{"$ref":"#/components/schemas/IdVerificationResultCheckEnum"}]},"dataBarcodeAnomalyContent":{"allOf":[{"$ref":"#/components/schemas/IdVerificationResultCheckEnum"}]},"dataBarcodeAnomalyRead":{"allOf":[{"$ref":"#/components/schemas/IdVerificationResultCheckEnum"}]},"dataSuspiciousOverall":{"allOf":[{"$ref":"#/components/schemas/IdVerificationResultCheckEnum"}]},"dataSuspiciousSampleString":{"allOf":[{"$ref":"#/components/schemas/IdVerificationResultCheckEnum"}]},"dataSuspiciousNumber":{"allOf":[{"$ref":"#/components/schemas/IdVerificationResultCheckEnum"}]},"dataIntegrity":{"allOf":[{"$ref":"#/components/schemas/IdVerificationResultCheckEnum"}]},"documentLivenessOverall":{"allOf":[{"$ref":"#/components/schemas/IdVerificationResultCheckEnum"}]},"documentLivenessScreen":{"allOf":[{"$ref":"#/components/schemas/IdVerificationResultCheckEnum"}]},"documentLivenessPhotocopy":{"allOf":[{"$ref":"#/components/schemas/IdVerificationResultCheckEnum"}]},"documentLivenessHandPresence":{"allOf":[{"$ref":"#/components/schemas/IdVerificationResultCheckEnum"}]},"visualOverall":{"allOf":[{"$ref":"#/components/schemas/IdVerificationResultCheckEnum"}]},"visualPhotoForgery":{"allOf":[{"$ref":"#/components/schemas/IdVerificationResultCheckEnum"}]},"visualSecurityFeatures":{"allOf":[{"$ref":"#/components/schemas/IdVerificationResultCheckEnum"}]},"documentExpired":{"allOf":[{"$ref":"#/components/schemas/IdVerificationResultCheckEnum"}]},"documentVersion":{"allOf":[{"$ref":"#/components/schemas/IdVerificationResultCheckEnum"}]},"imageQualityOverall":{"allOf":[{"$ref":"#/components/schemas/IdVerificationResultCheckEnum"}]},"imageQualityBlur":{"allOf":[{"$ref":"#/components/schemas/IdVerificationResultCheckEnum"}]},"imageQualityClarity":{"allOf":[{"$ref":"#/components/schemas/IdVerificationResultCheckEnum"}]},"formatCheckDetail":{"type":"object"},"matchCheckDetail":{"type":"object"},"messages":{"type":"object"}},"required":["id","createdAt","updatedAt","certainty"]},"VoucherContactInformation":{"type":"object","properties":{"email":{"type":"string"},"phoneNumber":{"type":"string","description":"Applicant phone number. Optional; only `email` is required."},"firstName":{"type":"string"},"middleName":{"type":"string"},"lastName":{"type":"string"},"suffix":{"type":"string"},"dateOfBirth":{"type":"string"},"primaryContactMethod":{"type":"string"}},"required":["email"]},"WalletConfigurationBeamInputTypeResponse":{"type":"object","properties":{"id":{"type":"string"},"slug":{"type":"string"},"version":{"type":"string"},"organizationId":{"type":"string"},"schema":{"type":"object","additionalProperties":true,"example":{}}},"required":["id","slug","version","organizationId","schema"]},"WalletConfigurationBeamResponse":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"organizationId":{"type":"string"},"beamInputType":{"nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/WalletConfigurationBeamInputTypeResponse"}]},"credentialType":{"nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/WalletConfigurationCredentialTypeResponse"}]}},"required":["id","name","organizationId","beamInputType","credentialType"]},"WalletConfigurationCredentialTypeResponse":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"slug":{"type":"string"},"version":{"type":"string"},"organizationId":{"type":"string","nullable":true},"schema":{"type":"object","additionalProperties":true,"example":{}}},"required":["id","name","slug","version","organizationId","schema"]},"WalletConfigurationPassTypeResponse":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"slug":{"type":"string"},"organizationId":{"type":"string"},"beams":{"type":"array","items":{"$ref":"#/components/schemas/WalletConfigurationBeamResponse"}}},"required":["id","name","slug","organizationId","beams"]},"WalletCredentialAttachment":{"type":"object","properties":{"partName":{"type":"string","example":"vaccinationCard"},"fieldPath":{"type":"string","example":"documents.vaccinationCardFileId"},"displayName":{"type":"string","example":"Vaccination card"}},"required":["partName"]},"WalletCredentialFileResponse":{"type":"object","properties":{"partName":{"type":"string"},"fileId":{"type":"string"},"name":{"type":"string"},"type":{"type":"string","nullable":true}},"required":["partName","fileId","name"]},"WalletSharePublicCredentialResponse":{"type":"object","properties":{"credentialId":{"type":"string","description":"Wallet credential id"},"userName":{"type":"string","nullable":true,"description":"Display name of the user who shared the credential"},"status":{"description":"Credential lifecycle status from CredentialStatusEnum","allOf":[{"$ref":"#/components/schemas/CredentialStatusEnum"}]},"data":{"type":"object","additionalProperties":true,"description":"Credential JSON payload; shape depends on the credential type schema"},"schema":{"type":"object","additionalProperties":true,"nullable":true,"description":"JSON Schema for this credential's type (titles, types, etc.)"},"issuerOrganizationName":{"type":"string","nullable":true,"description":"Name of the organization that issued this credential"},"files":{"description":"Active output files linked to this credential","type":"array","items":{"$ref":"#/components/schemas/WalletSharePublicFile"}}},"required":["credentialId","userName","status","data","schema","issuerOrganizationName","files"]},"WalletSharePublicFile":{"type":"object","properties":{"id":{"type":"string","description":"File id; use with GET /v1/public/wallet-shares/{token}/files/{fileId}"},"name":{"type":"string","description":"Original attachment file name"},"type":{"type":"string","nullable":true,"description":"MIME type when known (e.g. image/jpeg)"}},"required":["id","name","type"]},"WalletUserCredentialAttachmentResponse":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","nullable":true},"name":{"type":"string"},"url":{"type":"string","nullable":true}},"required":["id","name"]},"WalletUserCredentialBeamResponse":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"WalletUserCredentialOrganizationResponse":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"WalletUserCredentialPassTypeResponse":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"slug":{"type":"string"}},"required":["id","name","slug"]},"WalletUserCredentialResponse":{"type":"object","properties":{"id":{"type":"string"},"createdAt":{"format":"date-time","type":"string"},"status":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/CredentialStatusEnum"}]},"data":{"type":"object","additionalProperties":true,"example":{}},"organization":{"nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/WalletUserCredentialOrganizationResponse"}]},"passId":{"type":"string","nullable":true},"passType":{"nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/WalletUserCredentialPassTypeResponse"}]},"beam":{"nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/WalletUserCredentialBeamResponse"}]},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/WalletUserCredentialAttachmentResponse"}}},"required":["id","createdAt","data","organization","passType","beam","attachments"]},"vIDInviteResponseInviteData":{"type":"object","properties":{"metadata":{"type":"object","example":{"any_key":"value"}},"contactInformation":{"example":{"email":"johndoe@gmail.com","phoneNumber":"2087444184","firstName":"John","middleName":"M","lastName":"Doe","suffix":"Jr.","dateOfBirth":"1990-12-31","primaryContactMethod":"EMAIL"},"allOf":[{"$ref":"#/components/schemas/VoucherContactInformation"}]}},"required":["contactInformation"]},"vIDListInviteResponse":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the invite"},"status":{"type":"string","description":"The status of the invite","enum":["PENDING","STARTED","COMPLETE","ACCEPTED","CANCELED","OPT_OUT"]},"createdAt":{"format":"date-time","type":"string","description":"The creation date of the invite"},"updatedAt":{"format":"date-time","type":"string","description":"The last update date of the invite"},"firstName":{"type":"string","description":"The first name of the applicant","nullable":true},"middleName":{"type":"string","description":"The middle name of the applicant","nullable":true},"lastName":{"type":"string","description":"The last name of the applicant","nullable":true},"email":{"type":"string","description":"The email of the applicant"},"packageSetId":{"type":"string","description":"The ID of the package set used for the invite"},"metadata":{"type":"object","description":"The metadata of the invite","nullable":true},"inviteExpiry":{"type":"string","description":"Stored invite expiry as ISO 8601 UTC, or null when unset. Status does not change to EXPIRED.","format":"date-time","nullable":true},"inviteUrl":{"type":"string","description":"Stored invite link with its original routing. Older invites use the app shortcode when available; otherwise omitted."}},"required":["id","status","createdAt","updatedAt","firstName","middleName","lastName","email","packageSetId","metadata","inviteExpiry"]},"CreateRequestedSearchNatCrimRequest":{"type":"object","title":"nat+crim search","additionalProperties":false,"required":["searchType","data"],"properties":{"searchType":{"type":"string","enum":["nat+crim"]},"data":{"title":"Request payload for natcrim search","type":"object","additionalProperties":false,"properties":{"ssn":{"type":"string"},"lastName":{"type":"string"},"firstName":{"type":"string"},"middleName":{"type":"string"},"dateOfBirth":{"type":"string"}},"required":["lastName","firstName","middleName","dateOfBirth"],"description":"Applicant data for a nat+crim search."}}},"CreateRequestedSearchCountyRequest":{"type":"object","title":"county search","additionalProperties":false,"required":["searchType","data"],"properties":{"searchType":{"type":"string","enum":["county"]},"data":{"title":"Request payload for county search","type":"object","additionalProperties":false,"properties":{"ssn":{"type":"string"},"lastName":{"type":"string"},"firstName":{"type":"string"},"middleName":{"type":"string"},"dateOfBirth":{"type":"string"},"address":{"anyOf":[{"type":"object","additionalProperties":false,"properties":{"city":{"type":"string"},"state":{"type":"string"},"zipCode":{"type":"string"},"firstLine":{"type":"string"},"secondLine":{"type":"string"},"country":{"type":"string"},"county":{"type":"string"}},"required":["city","state","zipCode","firstLine","secondLine","country"]},{"type":"object","additionalProperties":false,"properties":{"city":{"type":"string"},"state":{"type":"string"},"zipCode":{"type":"string"},"firstLine":{"type":"string"},"secondLine":{"type":"string"},"country":{"type":"string"},"county":{"type":"string"}},"required":["county","state"]},{"type":"object","additionalProperties":false,"properties":{"fipsCode":{"type":"string","pattern":"^[0-9]{1,5}$"}},"required":["fipsCode"]}]}},"required":["ssn","lastName","firstName","middleName","dateOfBirth","address"],"description":"Applicant data for a county search."}}},"CreateRequestedSearchSsnRequest":{"type":"object","title":"ssn search","additionalProperties":false,"required":["searchType","data"],"properties":{"searchType":{"type":"string","enum":["ssn"]},"data":{"title":"Request payload for ssn search","type":"object","additionalProperties":false,"properties":{"ssn":{"type":"string"},"lastName":{"type":"string"},"firstName":{"type":"string"},"middleName":{"type":"string"},"dateOfBirth":{"type":"string"},"address":{"type":"object","additionalProperties":false,"properties":{"city":{"type":"string"},"state":{"type":"string"},"zipCode":{"type":"string"},"firstLine":{"type":"string"},"secondLine":{"type":"string"},"country":{"type":"string"},"county":{"type":"string"}},"required":["city","state","zipCode","firstLine","secondLine","country"]}},"required":["ssn","lastName","firstName","middleName","dateOfBirth"],"description":"Applicant data for a ssn search."}}},"CreateRequestedSearchIdentityRecheckRequest":{"type":"object","title":"identityRecheck search","additionalProperties":false,"required":["searchType","data"],"properties":{"searchType":{"type":"string","enum":["identityRecheck"]},"data":{"type":"object","additionalProperties":false,"properties":{"selfieFileId":{"type":"string","minLength":1}},"required":["selfieFileId"],"description":"Applicant data for a identityRecheck search."}}},"CreateRequestedSearchStandardIdVerificationRequest":{"type":"object","title":"standardIdVerification search","additionalProperties":false,"required":["searchType"],"properties":{"searchType":{"type":"string","enum":["standardIdVerification"]},"data":{"type":"object","nullable":true,"additionalProperties":true,"description":"Not used for this search type. Omit it."}}},"CreateRequestedSearchAamvaRequest":{"type":"object","title":"aamva search","additionalProperties":false,"required":["searchType","data"],"properties":{"searchType":{"type":"string","enum":["aamva"]},"data":{"title":"Request payload for aamva search","type":"object","additionalProperties":false,"properties":{"firstName":{"type":"string"},"lastName":{"type":"string"},"middleName":{"type":"string"},"dateOfBirth":{"type":"string"},"suffix":{"type":"string"},"licenseNumber":{"type":"string"},"licenseState":{"type":"string"}},"required":["lastName","firstName","dateOfBirth","licenseNumber","licenseState"],"description":"Applicant data for a aamva search."}}},"CreateRequestedSearchFastTrackRequest":{"type":"object","title":"fastTrack search","additionalProperties":false,"required":["searchType","data"],"properties":{"searchType":{"type":"string","enum":["fastTrack"]},"data":{"title":"Request payload for fast-track natcrim search","type":"object","additionalProperties":false,"properties":{"ssn":{"type":"string"},"lastName":{"type":"string"},"firstName":{"type":"string"},"middleName":{"type":"string"},"dateOfBirth":{"type":"string"}},"required":["ssn","lastName","firstName","middleName","dateOfBirth"],"description":"Applicant data for a fastTrack search."}}},"CreateRequestedSearchTazworksRequest":{"type":"object","title":"tazworks search","additionalProperties":false,"required":["searchType","data"],"properties":{"searchType":{"type":"string","enum":["tazworks"]},"data":{"title":"Request payload for TazWorks search","type":"object","additionalProperties":false,"properties":{"firstName":{"type":"string","minLength":1},"middleName":{"type":"string"},"lastName":{"type":"string","minLength":1},"suffix":{"type":"string"},"dateOfBirth":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"email":{"type":"string"},"phoneNumber":{"type":"string"},"address":{"type":"object","additionalProperties":false,"properties":{"addressLineOne":{"type":"string","minLength":1},"addressLineTwo":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"postalCode":{"type":"string"},"country":{"type":"string"}},"required":["addressLineOne"]}},"required":["firstName","lastName","dateOfBirth"],"description":"Applicant data for a tazworks search."}}},"CancelVIDInviteResponse":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["id","status"],"properties":{"id":{"type":"string","format":"uuid","description":"ID of the canceled invite."},"status":{"type":"string","enum":["CANCELED"]}}}}},"CreateVIDQuickInviteResponse":{"type":"object","required":["redirectUrl"],"properties":{"redirectUrl":{"type":"string","description":"vID web invite URL to send the applicant to (the invite's vIDWebInviteUrl)."}}},"InviteErrorResponse":{"type":"object","required":["error","email"],"description":"An applicant whose invite could not be created or re-sent. The request still succeeds.","properties":{"error":{"type":"string","description":"Error message."},"email":{"type":"string","description":"The applicant email, lower-cased."}}}},"headers":{"RateLimit-Policy":{"description":"Rate-limit policy as quota;w=window seconds: 5000 requests per 600-second window, counted per authenticated user or, without one, per client IP. Present on responses to requests that reach the shared rate limiter; requests rejected earlier, for example for a malformed JSON body, may not include the RateLimit headers.","schema":{"type":"string","example":"5000;w=600"}},"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer","example":5000}},"RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer","minimum":0,"example":4932}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"type":"integer","minimum":0,"example":191}}}}}