{"openapi": "3.1.0", "servers": [{"description": "BGC API", "url": "https://api.emptor.io/v3"}], "info": {"title": "BGC API", "version": "3.0.0", "contact": {"name": "API Support", "url": "https://emptor.io/contact/", "email": "support@emptor.io"}, "description": "This API allows to create and obtain person's BGC details."}, "paths": {"/{country_code}/persons": {"get": {"description": "Retrieve persons created within given criteria.\n", "summary": "Get Persons", "operationId": "get-persons", "tags": ["Persons"], "parameters": [{"$ref": "#/components/parameters/country_code"}, {"description": "Filter results by their document ID. Example: 12342123.\n", "example": "12342123", "in": "query", "name": "document_id", "required": false, "schema": {"type": "string"}}, {"description": "Filter by person creation date. Example: YYYY[-MM[-DD]]\n", "example": "2021-03-01", "in": "query", "name": "start_date", "required": false, "schema": {"type": "string"}}, {"description": "Filter by person creation date. Example: YYYY[-MM[-DD]]\n", "example": "2021-04-01", "in": "query", "name": "end_date", "required": false, "schema": {"type": "string"}}, {"description": "Maximum limit of results returned in a page.\nDefault and max limit is set to `1000`.\n", "example": "100", "in": "query", "name": "limit", "required": false, "schema": {"type": "string"}}, {"description": "Next batch ID to get next set of results.\n", "example": "AQICAHgk...", "in": "query", "name": "next_batch", "required": false, "schema": {"type": "string"}}], "responses": {"200": {"description": "Persons found within criteria.", "content": {"application/json": {"examples": {"response": {"value": {"data": [{"id": "09a3446b-bae9-4a03-8a4a-fcec24f784e4", "created_at": "2020-06-25T19:33:27.046266"}, {"id": "7e2acc72-4dc6-4ffe-8b31-cfeb13f567c5", "created_at": "2020-08-12T12:19:21.046266"}], "next_batch": "AQICAHgk..."}}}, "schema": {"$ref": "#/components/schemas/Get_Paginated_Persons"}}}}, "422": {"description": "Returned if the input data does not pass the validation.", "content": {"application/json": {"examples": {"response": {"value": {"message": "Invalid next_batch value."}}}, "schema": {"$ref": "#/components/schemas/response_error"}}}}, "500": {"description": "Returned if there was an internal error.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/response_error"}}}}, "503": {"description": "Returned if service is currently unavailable.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/response_error"}}}}}}}, "/ar/persons": {"post": {"description": "Create new person record with personal data. This triggers a reports\nupdate.\n", "operationId": "ar-create-person", "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/create_ar"}}}}, "responses": {"201": {"content": {"application/json": {"examples": {"response": {"value": "7e2acc72-4dc6-4ffe-8b31-cfeb13f567c5"}}}}, "description": "The created Person ID.", "headers": {}}, "400": {"content": {"application/json": {"examples": {"response": {"value": {"message": "Failed to parse JSON payload"}}}}}, "description": "Returned if there was a problem when processing the payload.", "headers": {}}, "404": {"content": {"application/json": {"examples": {"response": {"value": {"message": "Pipeline not found."}}}, "schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Returned if specified pipeline was not found."}, "422": {"content": {"application/json": {"examples": {"response": {"value": {"errors": {"city_locode": ["city locode must have 'CC XXX' format"], "document_id": ["required field"]}, "message": "Validation failed"}}}, "schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Returned if the input data does not pass the validation. Each field's\nerrors is included in the `errors` field with a description of the failure.", "headers": {}}, "500": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Returned if there was an internal error."}, "503": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Returned if service is currently unavailable."}}, "summary": "Create Argentina Person", "tags": ["Persons"]}}, "/br/persons": {"post": {"description": "Create new person record with personal data. This triggers a reports\nupdate.\n", "operationId": "br-create-person", "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/create_br"}}}}, "responses": {"201": {"content": {"application/json": {"examples": {"response": {"value": "7e2acc72-4dc6-4ffe-8b31-cfeb13f567c5"}}}}, "description": "The created Person ID.", "headers": {}}, "400": {"content": {"application/json": {"examples": {"response": {"value": {"message": "Failed to parse JSON payload"}}}}}, "description": "Returned if there was a problem when processing the payload.", "headers": {}}, "404": {"content": {"application/json": {"examples": {"response": {"value": {"message": "Pipeline not found."}}}, "schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Returned if specified pipeline was not found."}, "422": {"content": {"application/json": {"examples": {"response": {"value": {"errors": {"city_locode": ["city locode must have 'CC XXX' format"], "document_id": ["required field"]}, "message": "Validation failed"}}}, "schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Returned if the input data does not pass the validation. Each field's\nerrors is included in the `errors` field with a description of the failure.", "headers": {}}, "500": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Returned if there was an internal error."}, "503": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Returned if service is currently unavailable."}}, "summary": "Create Brazil Person", "tags": ["Persons"]}}, "/cl/persons": {"post": {"description": "Create new person record with personal data. This triggers a reports\nupdate.\n", "operationId": "cl-create-person", "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/create_cl"}}}}, "responses": {"201": {"content": {"application/json": {"examples": {"response": {"value": "7e2acc72-4dc6-4ffe-8b31-cfeb13f567c5"}}}}, "description": "The created Person ID.", "headers": {}}, "400": {"content": {"application/json": {"examples": {"response": {"value": {"message": "Failed to parse JSON payload"}}}}}, "description": "Returned if there was a problem when processing the payload.", "headers": {}}, "404": {"content": {"application/json": {"examples": {"response": {"value": {"message": "Pipeline not found."}}}, "schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Returned if specified pipeline was not found."}, "422": {"content": {"application/json": {"examples": {"response": {"value": {"errors": {"city_locode": ["city locode must have 'CC XXX' format"], "document_id": ["required field"]}, "message": "Validation failed"}}}, "schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Returned if the input data does not pass the validation. Each field's\nerrors is included in the `errors` field with a description of the failure.", "headers": {}}, "500": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Returned if there was an internal error."}, "503": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Returned if service is currently unavailable."}}, "summary": "Create Chile Person", "tags": ["Persons"]}}, "/co/persons": {"post": {"description": "Create new person record with personal data. This triggers a reports\nupdate.\n", "operationId": "co-create-person", "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/create_co"}}}}, "responses": {"201": {"content": {"application/json": {"examples": {"response": {"value": "7e2acc72-4dc6-4ffe-8b31-cfeb13f567c5"}}}}, "description": "The created Person ID.", "headers": {}}, "400": {"content": {"application/json": {"examples": {"response": {"value": {"message": "Failed to parse JSON payload"}}}}}, "description": "Returned if there was a problem when processing the payload.", "headers": {}}, "404": {"content": {"application/json": {"examples": {"response": {"value": {"message": "Pipeline not found."}}}, "schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Returned if specified pipeline was not found."}, "422": {"content": {"application/json": {"examples": {"response": {"value": {"errors": {"city_locode": ["city locode must have 'CC XXX' format"], "document_id": ["required field"]}, "message": "Validation failed"}}}, "schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Returned if the input data does not pass the validation. Each field's\nerrors is included in the `errors` field with a description of the failure.", "headers": {}}, "500": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Returned if there was an internal error."}, "503": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Returned if service is currently unavailable."}}, "summary": "Create Colombia Person", "tags": ["Persons"]}}, "/cr/persons": {"post": {"description": "Create new person record with personal data. This triggers a reports\nupdate.\n", "operationId": "cr-create-person", "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/create_cr"}}}}, "responses": {"201": {"content": {"application/json": {"examples": {"response": {"value": "7e2acc72-4dc6-4ffe-8b31-cfeb13f567c5"}}}}, "description": "The created Person ID.", "headers": {}}, "400": {"content": {"application/json": {"examples": {"response": {"value": {"message": "Failed to parse JSON payload"}}}}}, "description": "Returned if there was a problem when processing the payload.", "headers": {}}, "404": {"content": {"application/json": {"examples": {"response": {"value": {"message": "Pipeline not found."}}}, "schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Returned if specified pipeline was not found."}, "422": {"content": {"application/json": {"examples": {"response": {"value": {"errors": {"city_locode": ["city locode must have 'CC XXX' format"], "document_id": ["required field"]}, "message": "Validation failed"}}}, "schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Returned if the input data does not pass the validation. Each field's\nerrors is included in the `errors` field with a description of the failure.", "headers": {}}, "500": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Returned if there was an internal error."}, "503": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Returned if service is currently unavailable."}}, "summary": "Create Costa Rica Person", "tags": ["Persons"]}}, "/ec/persons": {"post": {"description": "Create new person record with personal data. This triggers a reports\nupdate.\n", "operationId": "ec-create-person", "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/create_ec"}}}}, "responses": {"201": {"content": {"application/json": {"examples": {"response": {"value": "7e2acc72-4dc6-4ffe-8b31-cfeb13f567c5"}}}}, "description": "The created Person ID.", "headers": {}}, "400": {"content": {"application/json": {"examples": {"response": {"value": {"message": "Failed to parse JSON payload"}}}}}, "description": "Returned if there was a problem when processing the payload.", "headers": {}}, "404": {"content": {"application/json": {"examples": {"response": {"value": {"message": "Pipeline not found."}}}, "schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Returned if specified pipeline was not found."}, "422": {"content": {"application/json": {"examples": {"response": {"value": {"errors": {"city_locode": ["city locode must have 'CC XXX' format"], "document_id": ["required field"]}, "message": "Validation failed"}}}, "schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Returned if the input data does not pass the validation. Each field's\nerrors is included in the `errors` field with a description of the failure.", "headers": {}}, "500": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Returned if there was an internal error."}, "503": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Returned if service is currently unavailable."}}, "summary": "Create Ecuador Person", "tags": ["Persons"]}}, "/mx/persons": {"post": {"description": "Create new person record with personal data. This triggers a reports\nupdate.\n", "operationId": "mx-create-person", "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/create_mx"}}}}, "responses": {"201": {"content": {"application/json": {"examples": {"response": {"value": "7e2acc72-4dc6-4ffe-8b31-cfeb13f567c5"}}}}, "description": "The created Person ID.", "headers": {}}, "400": {"content": {"application/json": {"examples": {"response": {"value": {"message": "Failed to parse JSON payload"}}}}}, "description": "Returned if there was a problem when processing the payload.", "headers": {}}, "404": {"content": {"application/json": {"examples": {"response": {"value": {"message": "Pipeline not found."}}}, "schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Returned if specified pipeline was not found."}, "422": {"content": {"application/json": {"examples": {"response": {"value": {"errors": {"city_locode": ["city locode must have 'CC XXX' format"], "document_id": ["required field"]}, "message": "Validation failed"}}}, "schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Returned if the input data does not pass the validation. Each field's\nerrors is included in the `errors` field with a description of the failure.", "headers": {}}, "500": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Returned if there was an internal error."}, "503": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Returned if service is currently unavailable."}}, "summary": "Create Mexico Person", "tags": ["Persons"]}}, "/pa/persons": {"post": {"description": "Create new person record with personal data. This triggers a reports\nupdate.\n", "operationId": "pa-create-person", "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/create_pa"}}}}, "responses": {"201": {"content": {"application/json": {"examples": {"response": {"value": "7e2acc72-4dc6-4ffe-8b31-cfeb13f567c5"}}}}, "description": "The created Person ID.", "headers": {}}, "400": {"content": {"application/json": {"examples": {"response": {"value": {"message": "Failed to parse JSON payload"}}}}}, "description": "Returned if there was a problem when processing the payload.", "headers": {}}, "404": {"content": {"application/json": {"examples": {"response": {"value": {"message": "Pipeline not found."}}}, "schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Returned if specified pipeline was not found."}, "422": {"content": {"application/json": {"examples": {"response": {"value": {"errors": {"city_locode": ["city locode must have 'CC XXX' format"], "document_id": ["required field"]}, "message": "Validation failed"}}}, "schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Returned if the input data does not pass the validation. Each field's\nerrors is included in the `errors` field with a description of the failure.", "headers": {}}, "500": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Returned if there was an internal error."}, "503": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Returned if service is currently unavailable."}}, "summary": "Create Panama Person", "tags": ["Persons"]}}, "/pe/persons": {"post": {"description": "Create new person record with personal data. This triggers a reports\nupdate.\n", "operationId": "pe-create-person", "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/create_pe"}}}}, "responses": {"201": {"content": {"application/json": {"examples": {"response": {"value": "7e2acc72-4dc6-4ffe-8b31-cfeb13f567c5"}}}}, "description": "The created Person ID.", "headers": {}}, "400": {"content": {"application/json": {"examples": {"response": {"value": {"message": "Failed to parse JSON payload"}}}}}, "description": "Returned if there was a problem when processing the payload.", "headers": {}}, "404": {"content": {"application/json": {"examples": {"response": {"value": {"message": "Pipeline not found."}}}, "schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Returned if specified pipeline was not found."}, "422": {"content": {"application/json": {"examples": {"response": {"value": {"errors": {"city_locode": ["city locode must have 'CC XXX' format"], "document_id": ["required field"]}, "message": "Validation failed"}}}, "schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Returned if the input data does not pass the validation. Each field's\nerrors is included in the `errors` field with a description of the failure.", "headers": {}}, "500": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Returned if there was an internal error."}, "503": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Returned if service is currently unavailable."}}, "summary": "Create Peru Person", "tags": ["Persons"]}}, "/{country_code}/persons/{person_id}": {"get": {"description": "Retrieve a person's attributes.\n", "summary": "Get a Person", "operationId": "get-person", "tags": ["Persons"], "parameters": [{"$ref": "#/components/parameters/country_code"}, {"$ref": "#/components/parameters/person_id"}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"created_at": "2017-09-25T22:48:37.708740", "city_locode": "BR-CBW", "document_id": "231.002.999-00", "document_id_type": "national_id", "id": "a1b2-c3d4-abcd-1234", "reports": {"cpf_status": "enabled"}, "updated_at": "2017-09-25T22:49:07.708740"}}}, "schema": {"anyOf": [{"$ref": "#/components/schemas/create_mx"}, {"$ref": "#/components/schemas/create_pe"}, {"$ref": "#/components/schemas/create_co"}, {"$ref": "#/components/schemas/create_cr"}, {"$ref": "#/components/schemas/create_cl"}, {"$ref": "#/components/schemas/create_br"}, {"$ref": "#/components/schemas/create_pa"}, {"$ref": "#/components/schemas/create_ec"}]}}}, "description": "OK", "headers": {}}, "404": {"description": "Returned if specified pipeline was not found.", "content": {"application/json": {"examples": {"response": {"value": {"message": "Person not found"}}}, "schema": {"$ref": "#/components/schemas/response_error"}}}}, "500": {"description": "Returned if there was an internal error.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/response_error"}}}}, "503": {"description": "Returned if service is currently unavailable.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/response_error"}}}}}}, "delete": {"description": "Delete a person.\n", "summary": "Delete a Person", "operationId": "delete-person", "tags": ["Persons"], "parameters": [{"$ref": "#/components/parameters/country_code"}, {"$ref": "#/components/parameters/person_id"}], "responses": {"204": {"description": "No Content", "headers": {}}, "500": {"description": "Returned if there was an internal error.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/response_error"}}}}, "503": {"description": "Returned if service is currently unavailable.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/response_error"}}}}}}}, "/ar/persons/{person_id}": {"post": {"description": "Update a person's attributes. This API performs a partial update based on the payload.\nFields not specified in the payload are not updated. This triggers a reports update.\n\nIf the person has a reports update in progress it will return a 409 response.\nYou can check the status endpoint to see the current reports status.\n", "operationId": "ar-update-person", "parameters": [{"$ref": "#/components/parameters/person_id"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/update_ar"}}}}, "responses": {"200": {"description": "OK", "headers": {}}, "404": {"content": {"application/json": {"examples": {"response": {"value": {"message": "Person not found"}}}, "schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Not Found", "headers": {}}, "409": {"content": {"application/json": {"examples": {"response": {"value": {"message": "Person has reports in progress."}}}, "schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Conflict", "headers": {}}, "422": {"content": {"application/json": {"examples": {"response": {"value": {"errors": {"city_locode": ["city locode must have 'CC XXX' format"], "document_id": ["required field"]}, "message": "Validation failed"}}}, "schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Returned if the input data does not pass the validation.", "headers": {}}, "500": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Returned if there was an internal error."}, "503": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Returned if service is currently unavailable."}}, "summary": "Update Argentina Person", "tags": ["Persons"]}}, "/br/persons/{person_id}": {"post": {"description": "Update a person's attributes. This API performs a partial update based on the payload.\nFields not specified in the payload are not updated. This triggers a reports update.\n\nIf the person has a reports update in progress it will return a 409 response.\nYou can check the status endpoint to see the current reports status.\n", "operationId": "br-update-person", "parameters": [{"$ref": "#/components/parameters/person_id"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/update_br"}}}}, "responses": {"200": {"description": "OK", "headers": {}}, "404": {"content": {"application/json": {"examples": {"response": {"value": {"message": "Person not found"}}}, "schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Not Found", "headers": {}}, "409": {"content": {"application/json": {"examples": {"response": {"value": {"message": "Person has reports in progress."}}}, "schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Conflict", "headers": {}}, "422": {"content": {"application/json": {"examples": {"response": {"value": {"errors": {"city_locode": ["city locode must have 'CC XXX' format"], "document_id": ["required field"]}, "message": "Validation failed"}}}, "schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Returned if the input data does not pass the validation.", "headers": {}}, "500": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Returned if there was an internal error."}, "503": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Returned if service is currently unavailable."}}, "summary": "Update Brazil Person", "tags": ["Persons"]}}, "/cl/persons/{person_id}": {"post": {"description": "Update a person's attributes. This API performs a partial update based on the payload.\nFields not specified in the payload are not updated. This triggers a reports update.\n\nIf the person has a reports update in progress it will return a 409 response.\nYou can check the status endpoint to see the current reports status.\n", "operationId": "cl-update-person", "parameters": [{"$ref": "#/components/parameters/person_id"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/update_cl"}}}}, "responses": {"200": {"description": "OK", "headers": {}}, "404": {"content": {"application/json": {"examples": {"response": {"value": {"message": "Person not found"}}}, "schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Not Found", "headers": {}}, "409": {"content": {"application/json": {"examples": {"response": {"value": {"message": "Person has reports in progress."}}}, "schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Conflict", "headers": {}}, "422": {"content": {"application/json": {"examples": {"response": {"value": {"errors": {"city_locode": ["city locode must have 'CC XXX' format"], "document_id": ["required field"]}, "message": "Validation failed"}}}, "schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Returned if the input data does not pass the validation.", "headers": {}}, "500": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Returned if there was an internal error."}, "503": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Returned if service is currently unavailable."}}, "summary": "Update Chile Person", "tags": ["Persons"]}}, "/co/persons/{person_id}": {"post": {"description": "Update a person's attributes. This API performs a partial update based on the payload.\nFields not specified in the payload are not updated. This triggers a reports update.\n\nIf the person has a reports update in progress it will return a 409 response.\nYou can check the status endpoint to see the current reports status.\n", "operationId": "co-update-person", "parameters": [{"$ref": "#/components/parameters/person_id"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/update_co"}}}}, "responses": {"200": {"description": "OK", "headers": {}}, "404": {"content": {"application/json": {"examples": {"response": {"value": {"message": "Person not found"}}}, "schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Not Found", "headers": {}}, "409": {"content": {"application/json": {"examples": {"response": {"value": {"message": "Person has reports in progress."}}}, "schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Conflict", "headers": {}}, "422": {"content": {"application/json": {"examples": {"response": {"value": {"errors": {"city_locode": ["city locode must have 'CC XXX' format"], "document_id": ["required field"]}, "message": "Validation failed"}}}, "schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Returned if the input data does not pass the validation.", "headers": {}}, "500": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Returned if there was an internal error."}, "503": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Returned if service is currently unavailable."}}, "summary": "Update Colombia Person", "tags": ["Persons"]}}, "/cr/persons/{person_id}": {"post": {"description": "Update a person's attributes. This API performs a partial update based on the payload.\nFields not specified in the payload are not updated. This triggers a reports update.\n\nIf the person has a reports update in progress it will return a 409 response.\nYou can check the status endpoint to see the current reports status.\n", "operationId": "cr-update-person", "parameters": [{"$ref": "#/components/parameters/person_id"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/update_cr"}}}}, "responses": {"200": {"description": "OK", "headers": {}}, "404": {"content": {"application/json": {"examples": {"response": {"value": {"message": "Person not found"}}}, "schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Not Found", "headers": {}}, "409": {"content": {"application/json": {"examples": {"response": {"value": {"message": "Person has reports in progress."}}}, "schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Conflict", "headers": {}}, "422": {"content": {"application/json": {"examples": {"response": {"value": {"errors": {"city_locode": ["city locode must have 'CC XXX' format"], "document_id": ["required field"]}, "message": "Validation failed"}}}, "schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Returned if the input data does not pass the validation.", "headers": {}}, "500": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Returned if there was an internal error."}, "503": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Returned if service is currently unavailable."}}, "summary": "Update Costa Rica Person", "tags": ["Persons"]}}, "/ec/persons/{person_id}": {"post": {"description": "Update a person's attributes. This API performs a partial update based on the payload.\nFields not specified in the payload are not updated. This triggers a reports update.\n\nIf the person has a reports update in progress it will return a 409 response.\nYou can check the status endpoint to see the current reports status.\n", "operationId": "ec-update-person", "parameters": [{"$ref": "#/components/parameters/person_id"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/update_ec"}}}}, "responses": {"200": {"description": "OK", "headers": {}}, "404": {"content": {"application/json": {"examples": {"response": {"value": {"message": "Person not found"}}}, "schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Not Found", "headers": {}}, "409": {"content": {"application/json": {"examples": {"response": {"value": {"message": "Person has reports in progress."}}}, "schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Conflict", "headers": {}}, "422": {"content": {"application/json": {"examples": {"response": {"value": {"errors": {"city_locode": ["city locode must have 'CC XXX' format"], "document_id": ["required field"]}, "message": "Validation failed"}}}, "schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Returned if the input data does not pass the validation.", "headers": {}}, "500": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Returned if there was an internal error."}, "503": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Returned if service is currently unavailable."}}, "summary": "Update Ecuador Person", "tags": ["Persons"]}}, "/mx/persons/{person_id}": {"post": {"description": "Update a person's attributes. This API performs a partial update based on the payload.\nFields not specified in the payload are not updated. This triggers a reports update.\n\nIf the person has a reports update in progress it will return a 409 response.\nYou can check the status endpoint to see the current reports status.\n", "operationId": "mx-update-person", "parameters": [{"$ref": "#/components/parameters/person_id"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/update_mx"}}}}, "responses": {"200": {"description": "OK", "headers": {}}, "404": {"content": {"application/json": {"examples": {"response": {"value": {"message": "Person not found"}}}, "schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Not Found", "headers": {}}, "409": {"content": {"application/json": {"examples": {"response": {"value": {"message": "Person has reports in progress."}}}, "schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Conflict", "headers": {}}, "422": {"content": {"application/json": {"examples": {"response": {"value": {"errors": {"city_locode": ["city locode must have 'CC XXX' format"], "document_id": ["required field"]}, "message": "Validation failed"}}}, "schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Returned if the input data does not pass the validation.", "headers": {}}, "500": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Returned if there was an internal error."}, "503": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Returned if service is currently unavailable."}}, "summary": "Update Mexico Person", "tags": ["Persons"]}}, "/pa/persons/{person_id}": {"post": {"description": "Update a person's attributes. This API performs a partial update based on the payload.\nFields not specified in the payload are not updated. This triggers a reports update.\n\nIf the person has a reports update in progress it will return a 409 response.\nYou can check the status endpoint to see the current reports status.\n", "operationId": "pa-update-person", "parameters": [{"$ref": "#/components/parameters/person_id"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/update_pa"}}}}, "responses": {"200": {"description": "OK", "headers": {}}, "404": {"content": {"application/json": {"examples": {"response": {"value": {"message": "Person not found"}}}, "schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Not Found", "headers": {}}, "409": {"content": {"application/json": {"examples": {"response": {"value": {"message": "Person has reports in progress."}}}, "schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Conflict", "headers": {}}, "422": {"content": {"application/json": {"examples": {"response": {"value": {"errors": {"city_locode": ["city locode must have 'CC XXX' format"], "document_id": ["required field"]}, "message": "Validation failed"}}}, "schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Returned if the input data does not pass the validation.", "headers": {}}, "500": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Returned if there was an internal error."}, "503": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Returned if service is currently unavailable."}}, "summary": "Update Panama Person", "tags": ["Persons"]}}, "/pe/persons/{person_id}": {"post": {"description": "Update a person's attributes. This API performs a partial update based on the payload.\nFields not specified in the payload are not updated. This triggers a reports update.\n\nIf the person has a reports update in progress it will return a 409 response.\nYou can check the status endpoint to see the current reports status.\n", "operationId": "pe-update-person", "parameters": [{"$ref": "#/components/parameters/person_id"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/update_pe"}}}}, "responses": {"200": {"description": "OK", "headers": {}}, "404": {"content": {"application/json": {"examples": {"response": {"value": {"message": "Person not found"}}}, "schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Not Found", "headers": {}}, "409": {"content": {"application/json": {"examples": {"response": {"value": {"message": "Person has reports in progress."}}}, "schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Conflict", "headers": {}}, "422": {"content": {"application/json": {"examples": {"response": {"value": {"errors": {"city_locode": ["city locode must have 'CC XXX' format"], "document_id": ["required field"]}, "message": "Validation failed"}}}, "schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Returned if the input data does not pass the validation.", "headers": {}}, "500": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Returned if there was an internal error."}, "503": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Returned if service is currently unavailable."}}, "summary": "Update Peru Person", "tags": ["Persons"]}}, "/{country_code}/persons/{person_id}/status": {"get": {"description": "Retrieve the status of a Person's reports. Only the currently enabled reports will be returned.", "operationId": "get-person-status", "summary": "Get a Person Status", "tags": ["Persons"], "parameters": [{"$ref": "#/components/parameters/country_code"}, {"$ref": "#/components/parameters/person_id"}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"created_at": "2017-09-25T22:48:37.708740", "id": "09a3446b-bae9-4a03-8a4a-fcec24f784e4", "reports": {"cpf_status": {"created_at": "2017-09-25T22:48:35.123456", "outcome": "PASSED", "state": "COMPLETED", "updated_at": "2017-09-25T22:49:00.708740"}, "criminal_records": {"created_at": "2017-09-25T22:48:37.654321", "outcome": "PASSED", "state": "COMPLETED", "updated_at": "2017-09-25T23:30:11.708740", "reviewed_at": "2017-09-25T23:30:07.115140"}}, "manual_review": {"observations": "This is a summary why the person was PASSED.", "validation_comment": "", "crime_category": "", "sentencing_status": "", "confirmed_homonym": false, "excluded_process_type": false}, "status": "PASSED", "updated_at": "2017-09-25T23:30:11.708740", "custom_data": null}}}, "schema": {"$ref": "#/components/schemas/Get_Person_Status"}}}, "description": "OK", "headers": {}}, "404": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/response_error"}, "examples": {"response": {"value": {"message": "Person not found"}}}}}, "description": "Not Found", "headers": {}}, "500": {"description": "Returned if there was an internal error.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/response_error"}}}}, "503": {"description": "Returned if service is currently unavailable.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/response_error"}}}}}}}, "/{country_code}/reports/{person_id}": {"get": {"description": "Retrieve reports for given person. Only the currently enabled reports\nwill be returned.\n", "summary": "Get reports", "operationId": "get-reports", "tags": ["Reports"], "parameters": [{"$ref": "#/components/parameters/country_code"}, {"$ref": "#/components/parameters/person_id"}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"name_check": {"state": "COMPLETED", "outcome": "PASSED", "created_at": "2017-09-25T22:48:37.708740", "updated_at": "2017-09-25T22:49:07.708740"}, "dob_check": {"state": "COMPLETED", "outcome": "PASSED", "created_at": "2017-09-25T22:48:37.708740", "updated_at": "2017-09-25T22:49:07.708740"}, "sanctions": {"state": "COMPLETED", "outcome": "PASSED", "created_at": "2017-09-25T22:48:37.708740", "updated_at": "2017-09-25T22:49:07.708740"}}}}, "schema": {"$ref": "#/components/schemas/Get_Reports_Response"}}}, "description": "OK", "headers": {}}, "404": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/response_error"}, "examples": {"response": {"value": {"message": "Person not found"}}}}}, "description": "Not Found", "headers": {}}, "500": {"description": "Returned if there was an internal error.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/response_error"}}}}, "503": {"description": "Returned if service is currently unavailable.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/response_error"}}}}}}}, "/{country_code}/details/{person_id}": {"get": {"description": "Retrieve all report details for a given person.\n", "summary": "Get reports details", "operationId": "get-reports-details", "tags": ["Reports"], "parameters": [{"$ref": "#/components/parameters/country_code"}, {"$ref": "#/components/parameters/person_id"}], "responses": {"200": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Get_All_Report_Details"}, "examples": {"response": {"value": {"person_id": "a1b2-c3d4-abcd-1234", "reports": {"name_check": {"state": "COMPLETED", "outcome": "PASSED", "details": {"score": 1, "full_name": "Sheldon Lee Cooper", "name_fragment_check": false, "name_score_min": 1, "message": null}, "created_at": "2017-09-25T22:48:37.708740", "updated_at": "2017-09-25T22:49:07.708740"}, "dob_check": {"state": "COMPLETED", "outcome": "PASSED", "details": {"dob": "26-02-1980", "message": null}, "created_at": "2017-09-25T22:48:37.708740", "updated_at": "2017-09-25T22:49:07.708740"}, "sanctions": {"state": "COMPLETED", "outcome": "PASSED", "details": {"matches": {"UN": [], "OFAC": [], "EEAS": [], "World Bank - Debarred firms and individuals": [], "World Bank - other sanctions": []}, "found_matches": false}, "created_at": "2017-09-25T22:48:37.708740", "updated_at": "2017-09-25T22:49:07.708740"}}}}}}}, "description": "OK", "headers": {}}, "404": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/response_error"}, "examples": {"response": {"value": {"message": "Person not found"}}}}}, "description": "Not Found", "headers": {}}, "500": {"description": "Returned if there was an internal error.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/response_error"}}}}, "503": {"description": "Returned if service is currently unavailable.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/response_error"}}}}}}}, "/{country_code}/reports/{person_id}/update": {"post": {"description": "Trigger a reports update. This will return a 409 if a reports update is\nalready in progress.\n", "summary": "Update reports", "operationId": "update-reports", "tags": ["Reports"], "parameters": [{"$ref": "#/components/parameters/country_code"}, {"$ref": "#/components/parameters/person_id"}], "responses": {"202": {"description": "Accepted", "headers": {}}, "404": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/response_error"}, "examples": {"response": {"value": {"message": "Person not found"}}}}}, "description": "Not Found", "headers": {}}, "409": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/response_error"}, "examples": {"response": {"value": {"message": "Person has reports in progress."}}}}}, "description": "Conflict", "headers": {}}, "422": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/response_error"}, "examples": {"response": {"value": {"errors": {"field_required": ["required field"]}, "message": "Validation failed: The current profile data is not sufficient for the current report configuration"}}}}}, "description": "Unprocessable Entity", "headers": {}}}}}, "/ec/details/{person_id}/{report_name}": {"get": {"description": "Retrieve details for a **single report** from the reports available in Ecuador.\n\nOnly enabled reports for a given person can be retrieved.\n", "summary": "Ecuador", "operationId": "ec-report-details", "tags": ["Report details"], "parameters": [{"$ref": "#/components/parameters/person_id"}, {"$ref": "#/components/parameters/ec_report_name"}], "responses": {"200": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/ec_one_of"}}}, "description": "OK", "headers": {}}, "404": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/response_error"}, "examples": {"response": {"value": {"message": "Person not found"}}}}}, "description": "Not Found", "headers": {}}, "500": {"description": "Returned if there was an internal error.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/response_error"}}}}, "503": {"description": "Returned if service is currently unavailable.", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/response_error"}}}}}}}, "/pa/details/{person_id}/{report_name}": {"get": {"description": "Retrieve details for a **single report** from the reports available in Panama.\n\nOnly enabled reports for a given person can be retrieved.\n", "summary": "Panama", "operationId": "pa-report-details", "tags": ["Report details"], "parameters": [{"$ref": "#/components/parameters/person_id"}, {"$ref": "#/components/parameters/pa_report_name"}], "responses": {"200": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/pa_one_of"}}}, "description": "OK", "headers": {}}, "404": {"content": {"application/json": {"examples": {"response": {"value": {"message": "Person not found"}}}}}, "description": "Not Found", "headers": {}}}}}, "/co/details/{person_id}/{report_name}": {"get": {"description": "Retrieve details for a **single report** from the reports available in Colombia.\n\nOnly enabled reports for a given person can be retrieved.\n", "summary": "Colombia", "operationId": "co-report-details", "tags": ["Report details"], "parameters": [{"$ref": "#/components/parameters/person_id"}, {"$ref": "#/components/parameters/co_report_name"}], "responses": {"200": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/co_one_of"}}}, "description": "OK", "headers": {}}, "404": {"content": {"application/json": {"examples": {"response": {"value": {"message": "Person not found"}}}}}, "description": "Not Found", "headers": {}}}}}, "/mx/details/{person_id}/{report_name}": {"get": {"description": "Retrieve details for a **single report** from the reports available in Mexico.\n\nOnly enabled reports for a given person can be retrieved.\n", "summary": "Mexico", "operationId": "mx-report-details", "tags": ["Report details"], "parameters": [{"$ref": "#/components/parameters/person_id"}, {"$ref": "#/components/parameters/mx_report_name"}], "responses": {"200": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/mx_one_of"}}}, "description": "OK", "headers": {}}, "404": {"content": {"application/json": {"examples": {"response": {"value": {"message": "Person not found"}}}}}, "description": "Not Found", "headers": {}}}}}, "/pe/details/{person_id}/{report_name}": {"get": {"description": "Retrieve details for a **single report** from the reports available in Peru.\n\nOnly enabled reports for a given person can be retrieved.\n", "summary": "Peru", "operationId": "pe-report-details", "tags": ["Report details"], "parameters": [{"$ref": "#/components/parameters/person_id"}, {"$ref": "#/components/parameters/pe_report_name"}], "responses": {"200": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/pe_one_of"}}}, "description": "OK", "headers": {}}, "404": {"content": {"application/json": {"examples": {"response": {"value": {"message": "Person not found"}}}}}, "description": "Not Found", "headers": {}}}}}, "/cl/details/{person_id}/{report_name}": {"get": {"description": "Retrieve details for a **single report** from the reports available in Chile.\n\nOnly enabled reports for a given person can be retrieved.\n", "summary": "Chile", "operationId": "cl-report-details", "tags": ["Report details"], "parameters": [{"$ref": "#/components/parameters/person_id"}, {"$ref": "#/components/parameters/cl_report_name"}], "responses": {"200": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/cl_one_of"}}}, "description": "OK", "headers": {}}, "404": {"content": {"application/json": {"examples": {"response": {"value": {"message": "Person not found"}}}}}, "description": "Not Found", "headers": {}}}}}, "/cr/details/{person_id}/{report_name}": {"get": {"description": "Retrieve details for a **single report** from the reports available in Costa Rica.\n\nOnly enabled reports for a given person can be retrieved.\n", "summary": "Costa Rica", "operationId": "cr-report-details", "tags": ["Report details"], "parameters": [{"$ref": "#/components/parameters/person_id"}, {"$ref": "#/components/parameters/cr_report_name"}], "responses": {"200": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/cr_one_of"}}}, "description": "OK", "headers": {}}, "404": {"content": {"application/json": {"examples": {"response": {"value": {"message": "Person not found"}}}}}, "description": "Not Found", "headers": {}}}}}, "/br/details/{person_id}/{report_name}": {"get": {"description": "Retrieve details for a **single report** from the reports available in Brazil.\n\nOnly enabled reports for a given person can be retrieved.\n", "summary": "Brazil", "operationId": "br-report-details", "tags": ["Report details"], "parameters": [{"$ref": "#/components/parameters/person_id"}, {"$ref": "#/components/parameters/br_report_name"}], "responses": {"200": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/br_one_of"}}}, "description": "OK", "headers": {}}, "404": {"content": {"application/json": {"examples": {"response": {"value": {"message": "Person not found"}}}}}, "description": "Not Found", "headers": {}}}}}, "/ar/details/{person_id}/{report_name}": {"get": {"description": "Retrieve details for a **single report** from the reports available in Argentina.\n\nOnly enabled reports for a given person can be retrieved.\n", "summary": "Argentina", "operationId": "ar-report-details", "tags": ["Report details"], "parameters": [{"$ref": "#/components/parameters/person_id"}, {"$ref": "#/components/parameters/ar_report_name"}], "responses": {"200": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/ar_one_of"}}}, "description": "OK", "headers": {}}, "404": {"content": {"application/json": {"examples": {"response": {"value": {"message": "Person not found"}}}}}, "description": "Not Found", "headers": {}}}}}, "/pipelines": {"post": {"description": "Create a pipeline. When the pipeline is created an automatic ID called pipeline_id will be assigned.\n", "summary": "Create a pipeline", "operationId": "create-pipeline", "tags": ["Pipelines"], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/create_pipeline_schema"}, "examples": {"brazil_example": {"value": {"name": "test-pipeline", "country_code": "BR", "reports_enabled": ["name_check"], "alias": "Drivers Test 2", "description": "A short description about this pipeline.", "reports_settings": {"name_check": {"name_score_min": 0.2, "name_fragment_check": true}}}}}}}}, "responses": {"201": {"content": {"application/json": {"examples": {"response": {"value": {"name": "test-pipeline", "country_code": "BR", "reports_enabled": ["name_check"], "report_settings": {"name_check": {"name_score_min": 0.2, "name_fragment_check": true}}, "alias": "Drivers Test", "description": "A short description about this pipeline.", "pipeline_id": "0ujsszwN8NRY24YaXiTIE2VWDTS"}}}, "schema": {"$ref": "#/components/schemas/create_pipeline_response_schema"}}}, "description": "OK", "headers": {}}, "400": {"content": {"application/json": {"examples": {"response": {"value": {"message": "Pipeline already exists."}}}, "schema": {"type": "object", "properties": {"message": {"type": "string"}}}}}, "description": "Returned if pipeline is already created.", "headers": {}}, "422": {"content": {"application/json": {"examples": {"response": {"value": {"message": "Validation failed.", "errors": {"report_settings": ["Unsupported report in settings."]}}}}, "schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Returned if validation fails.", "headers": {}}}}, "get": {"description": "Get paginated created pipelines.\n", "summary": "List pipelines", "operationId": "list-pipelines", "tags": ["Pipelines"], "parameters": [{"$ref": "#/components/parameters/pipeline_next_batch"}, {"$ref": "#/components/parameters/pipeline_limit"}], "responses": {"200": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/list_pipeline_schema"}}}, "description": "OK", "headers": {}}}}}, "/pipelines/{pipeline_id}": {"get": {"description": "Get a pipeline's attributes.\n", "summary": "Get a pipeline", "operationId": "get-pipeline", "tags": ["Pipelines"], "parameters": [{"$ref": "#/components/parameters/pipeline_id"}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"name": "test-pipeline", "country_code": "BR", "reports_enabled": ["name_check"], "report_settings": {"name_check": {"name_score_min": 0.2, "name_fragment_check": true}}, "alias": "Drivers Test", "description": "A short description about this pipeline.", "pipeline_id": "0ujsszwN8NRY24YaXiTIE2VWDTS"}}}, "schema": {"$ref": "#/components/schemas/create_pipeline_response_schema"}}}, "description": "OK", "headers": {}}, "400": {"content": {"application/json": {"examples": {"response": {"value": {"message": "Pipeline not found."}}}, "schema": {"type": "object", "properties": {"message": {"type": "string"}}}}}, "description": "Returned if pipeline is not found.", "headers": {}}}}, "patch": {"description": "Update a pipeline's attributes. This API performs a partial update based on the payload.\nFields not specified in the payload are not updated. country_code and pipeline_id fields do not admit changes.\n", "summary": "Update a pipeline", "operationId": "update-pipeline", "tags": ["Pipelines"], "parameters": [{"$ref": "#/components/parameters/pipeline_id"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/update_pipeline_schema"}}}}, "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"type": "object", "properties": {}}}}, "headers": {}}, "400": {"content": {"application/json": {"examples": {"response": {"value": {"message": "Pipeline not found."}}}, "schema": {"type": "object", "properties": {"message": {"type": "string"}}}}}, "description": "Returned if pipeline is not found.", "headers": {}}, "422": {"content": {"application/json": {"examples": {"response": {"value": {"message": "Validation failed.", "errors": {"report_settings": ["Unsupported report in settings."]}}}}, "schema": {"$ref": "#/components/schemas/response_error"}}}, "description": "Returned if validation fails.", "headers": {}}}}, "delete": {"description": "Delete a pipeline by pipeline_id.\n", "summary": "Delete a pipeline", "operationId": "delete-pipeline", "tags": ["Pipelines"], "parameters": [{"$ref": "#/components/parameters/pipeline_id"}], "responses": {"200": {"description": "OK", "content": {"application/json": {"schema": {"type": "object", "properties": {}}}}, "headers": {}}, "400": {"content": {"application/json": {"examples": {"response": {"value": {"message": "Pipeline not found."}}}, "schema": {"type": "object", "properties": {}}}}, "description": "Returned if pipeline is not found.", "headers": {}}}}}, "/pipelines/{pipeline_id}/schema": {"get": {"description": "Retrieve the list of fields required to create a person when using the current pipeline.\n", "summary": "Get pipeline schema", "operationId": "get-pipeline-schema", "tags": ["Pipelines"], "parameters": [{"$ref": "#/components/parameters/pipeline_id"}], "responses": {"200": {"content": {"application/json": {"examples": {"response": {"value": {"title": "Person", "description": "Person schema to use for a report", "type": "object", "properties": {"document_id": {"type": "string"}, "city_locode": {"type": "string"}, "pipeline": {"ref": "#/definitions/Pipeline"}}, "required": ["document_id", "city_locode", "pipeline"], "definitions": {"Pipeline": {"title": "Pipeline", "type": "object", "properties": {"name": {"title": "Name", "enum": ["test-pipeline"]}}, "required": ["name"]}}}}}, "schema": {"$ref": "#/components/schemas/get_pipeline_schema_response_schema"}}}, "description": "OK", "headers": {}}, "404": {"content": {"application/json": {"examples": {"response": {"value": {"message": "Pipeline not found."}}}, "schema": {"type": "object", "properties": {"message": {"type": "string"}}}}}, "description": "Returned if pipeline is not found.", "headers": {}}}}}, "/valuesets": {"get": {"description": "Get a list of possible valuesests.\n", "summary": "List valuesets", "operationId": "list-valuesets", "tags": ["Valuesets"], "responses": {"200": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Valuesets_Details_Response"}}}, "description": "OK", "headers": {}}}}}, "/valuesets/{valueset_value}": {"get": {"description": "Get a valuesets' attributes.\n", "summary": "Get a valueset", "operationId": "get-valueset", "tags": ["Valuesets"], "parameters": [{"$ref": "#/components/parameters/valueset_value"}], "responses": {"200": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Valuesets_Details_Response"}}}, "description": "OK", "headers": {}}, "404": {"content": {"application/json": {"examples": {"response": {"value": {"message": "ValueSet {valueset_name} not found."}}}, "schema": {"type": "object", "properties": {"message": {"type": "string"}}}}}, "description": "Returned if valueset is not found.", "headers": {}}}}}, "/webhooks/mapping": {"post": {"description": "Configure webhook for current user to receive folder finished notifications.\nPlease contact support if you want to use our webhook integration.\n", "summary": "Configure webhook", "operationId": "configure-webhook", "tags": ["Webhooks"], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/configure_webhook_schema"}, "examples": {"webhook_example": {"value": {"webhook_url": "https://yourwebhook.example.com/path/to/webhook?some_field=some-value"}}, "webhook_example_with_headers": {"value": {"webhook_url": "https://yourwebhook.example.com/path/to/webhook", "webhook_headers": {"some_header_field": "some-value", "some_secret_field": "some-secret-value"}}}}}}}, "responses": {"200": {"description": "OK. No Content", "headers": {}}, "422": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/response_error"}, "examples": {"response": {"value": {"errors": {"webhook_url": ["required field"]}, "message": "Validation failed: Provided webhook data..."}}}}}, "description": "Unprocessable Entity", "headers": {}}}}}}, "components": {"securitySchemes": {"ApiKeyAuth": {"type": "apiKey", "in": "header", "name": "X-Api-Key"}}, "parameters": {"country_code": {"description": "Country Code (ISO 3166).", "example": "mx", "in": "path", "name": "country_code", "required": true, "schema": {"type": "string", "enum": ["mx", "pe", "co", "cr", "br", "cl", "pa", "ec", "ar"]}}, "person_id": {"description": "person id", "example": "7e2acc72-4dc6-4ffe-8b31-cfeb13f567c5", "in": "path", "name": "person_id", "required": true, "schema": {"type": "string"}}, "ec_report_name": {"description": "Report name.", "example": "license_status", "in": "path", "name": "report_name", "required": true, "schema": {"enum": ["license_status", "driving_record", "justice_record", "cedula_details", "news_search", "sanctions", "name_check"], "type": "string"}}, "pa_report_name": {"description": "Report name.", "example": "cedula_details", "in": "path", "name": "report_name", "required": true, "schema": {"enum": ["cedula_details", "criminal_record", "license_status", "drunk_driving", "sanctions", "news_search"], "type": "string"}}, "co_report_name": {"description": "Report name.", "example": "license_status", "in": "path", "name": "report_name", "required": true, "schema": {"enum": ["license_status", "drunk_driving", "fine_debt", "fine_count", "justice_record", "police_record", "cedula_details", "procuradoria_record", "vehicle_check", "sanctions", "name_check", "process_search", "news_search"], "type": "string"}}, "mx_report_name": {"description": "Report name.", "example": "curp", "in": "path", "name": "report_name", "required": true, "schema": {"enum": ["curp", "federal_match", "state_match", "us_match", "nss", "rfc", "labor_history", "professional_license", "criminal", "fiscal_info", "verify_cfdi", "vehicle_check", "license_status", "social_media", "news_search", "federal_records", "name_check", "dob_check", "sanctions"], "type": "string"}}, "pe_report_name": {"description": "Report name.", "example": "license_status", "in": "path", "name": "report_name", "required": true, "schema": {"enum": ["license_status", "drunk_driving", "dangerous_driver", "justice_certificate", "foreigner_card_status", "dni_status", "most_wanted", "police_arrest", "labor_certificate", "boletin_judicial", "document_id_status", "sanctions", "name_check", "news_search"], "type": "string"}}, "cl_report_name": {"description": "Report name.", "example": "run_status", "in": "path", "name": "report_name", "required": true, "schema": {"enum": ["run_status", "justice_certificate", "license_status", "criminal", "mtt_taxi", "vehicle_check", "sanctions", "name_check", "news_search"], "type": "string"}}, "cr_report_name": {"description": "Report name.", "example": "cedula_status", "in": "path", "name": "report_name", "required": true, "schema": {"enum": ["cedula_status", "boletin_judicial", "name_check", "dob_check", "sanctions", "archivo_judicial", "news_search"], "type": "string"}}, "br_report_name": {"description": "Report name.", "example": "national_criminal_record", "in": "path", "name": "report_name", "required": true, "schema": {"enum": ["national_criminal_record", "cpf_status", "arrest_warrants", "police_records", "criminal_records", "esocial", "detran_check", "sanctions", "name_check", "dob_check", "news_search", "ac_state_records", "al_state_records", "am_state_records", "ap_state_records", "ba_state_records", "ce_state_records", "df_state_records", "es_state_records", "go_state_records", "ma_state_records", "mg_state_records", "ms_state_records", "mt_state_records", "pa_state_records", "pb_state_records", "pe_state_records", "pi_state_records", "pr_state_records", "rj_state_records", "rn_state_records", "ro_state_records", "rr_state_records", "sc_state_records", "se_state_records", "sp_state_records"], "type": "string"}}, "ar_report_name": {"description": "Report name.", "example": "id_status", "in": "path", "name": "report_name", "required": true, "schema": {"enum": ["id_status", "criminal_search", "federal_inmates", "national_fugitives", "sanctions", "name_check", "news_search"], "type": "string"}}, "pipeline_next_batch": {"description": "Next batch ID to get next set of results.", "example": "AQICAHgk...", "in": "query", "name": "next_batch", "required": false, "schema": {"type": "string"}}, "pipeline_limit": {"description": "Maximum limit of results returned in a page. Default and max limit is set to 1000.", "example": "100", "in": "query", "name": "limit", "required": false, "schema": {"type": "string"}}, "pipeline_id": {"description": "Pipeline id", "example": "0ujsszwN8NRY24YaXiTIE2VWDTS", "in": "path", "name": "pipeline_id", "required": true, "schema": {"type": "string"}}, "valueset_value": {"description": "Valueset Name", "example": "CrimeCategories", "in": "path", "name": "valueset_value", "required": true, "schema": {"type": "string"}}}, "schemas": {"PaginatedPerson": {"description": "Part of GetPersonsResponse.data.", "properties": {"created_at": {"description": "Timestamp of person created.", "title": "Created At", "type": "string"}, "id": {"description": "Person ID.", "title": "Id", "type": "string"}}, "required": ["id", "created_at"], "title": "PaginatedPerson", "type": "object"}, "Get_Paginated_Persons": {"definitions": {"PaginatedPerson": {"description": "Part of GetPersonsResponse.data.", "properties": {"created_at": {"description": "Timestamp of person created.", "title": "Created At", "type": "string"}, "id": {"description": "Person ID.", "title": "Id", "type": "string"}}, "required": ["id", "created_at"], "title": "PaginatedPerson", "type": "object"}}, "description": "Response for GET /<country>/persons endpoint.", "properties": {"data": {"description": "Array of persons found.", "items": {"$ref": "#/components/schemas/PaginatedPerson"}, "title": "Data", "type": "array"}, "next_batch": {"description": "Next batch ID returned. If there is no next batch, is set to null.", "title": "Next Batch", "type": "string"}}, "required": ["data"], "title": "Get Paginated Persons", "type": "object"}, "response_error": {"title": "Response Error", "type": "object", "required": ["message"], "properties": {"message": {"description": "Error detail description.\n", "type": "string"}, "errors": {"description": "Fields with arrays of all errors found.\n", "type": "object"}}}, "SearchType": {"description": "Valid search types for criminal_search report.", "enum": ["forenames+surname", "document_id", "full_name"], "title": "SearchType", "type": "string"}, "SourceList": {"description": "Valid sources for criminal_search report.", "enum": ["boletin_pba", "boletin_rarg", "boletin_cba", "sentencias_cij", "boletin_pch", "boletin_corr", "boletin_rios", "boletin_mis", "boletin_neuq", "boletin_neg", "boletin_salt", "boletin_scz"], "title": "SourceList", "type": "string"}, "bgcapi__schemas__report_settings__ar__criminal_search__Settings": {"description": "Report settings schema for criminal_search report.", "properties": {"criminal_age_majority": {"description": "Records older than age of this person, will be ignored.", "title": "Criminal Age Majority", "type": "integer"}, "max_record_age_years": {"description": "Records older than this number of years will be ignored.", "title": "Max Record Age Years", "type": "integer"}, "name_score_min": {"default": 1, "description": "Minimum score for name match (0.00 <= n <= 1.00).", "title": "Name Score Min", "type": "number"}, "search_type": {"allOf": [{"$ref": "#/components/schemas/SearchType"}], "default": "full_name", "description": "Specific fields to be used while performing a search."}, "source_list": {"default": ["boletin_pba", "boletin_rarg", "boletin_cba", "sentencias_cij", "boletin_pch", "boletin_corr", "boletin_rios", "boletin_mis", "boletin_neuq", "boletin_neg", "boletin_salt", "boletin_scz"], "description": "Specific source to perform a search.", "items": {"$ref": "#/components/schemas/SourceList"}, "type": "array"}}, "title": "AR Criminal Search Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__ar__federal_inmates__Settings": {"description": "Report settings for federal_inmates report.", "properties": {"crime_whitelist": {"default": [], "description": "List of strings to be used to whitelist crimes. If the value is found, the record  is ignored.", "items": {"type": "string"}, "title": "Crime Whitelist", "type": "array"}, "info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}}, "title": "AR Federal Inmates Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__ar__id_status__Settings": {"description": "Report settings schema for id_status report.", "properties": {"invalid_dob_action": {"default": "INCOMPLETE", "description": "Action that should be taken if status is `invalid_dob`.", "enum": ["FAILED", "PASSED", "INCOMPLETE"], "title": "Invalid Dob Action", "type": "string"}, "invalid_document_id_action": {"default": "INCOMPLETE", "description": "Action that should be taken if status is `invalid_document_id`.", "enum": ["FAILED", "PASSED", "INCOMPLETE"], "title": "Invalid Document Id Action", "type": "string"}, "invalid_document_id_or_gender_action": {"default": "INCOMPLETE", "description": "Action that should be taken if status is `invalid_document_id_or_gender`.", "enum": ["FAILED", "PASSED", "INCOMPLETE"], "title": "Invalid Document Id Or Gender Action", "type": "string"}, "invalid_gender_action": {"default": "INCOMPLETE", "description": "Action that should be taken if status is `invalid_gender`.", "enum": ["FAILED", "PASSED", "INCOMPLETE"], "title": "Invalid Gender Action", "type": "string"}, "not_found_action": {"default": "INCOMPLETE", "description": "Action that should be taken if status is `not_found`.", "enum": ["FAILED", "PASSED", "INCOMPLETE"], "title": "Not Found Action", "type": "string"}}, "title": "AR Id Status Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__common__name_check__Settings": {"description": "Report settings for name_check report.", "properties": {"name_fragment_check": {"default": false, "description": "If the report should check for name fragments instead of full name check.", "title": "Name Fragment Check", "type": "boolean"}, "name_score_min": {"default": 1, "description": "Minimum score for name match for a PASSED outcome (0.00 <= n <= 1.00).", "title": "Name Score Min", "type": "number"}}, "title": "Name Check Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__ar__national_fugitives__Settings": {"description": "Report settings for national_fugitives report.", "properties": {"crime_whitelist": {"default": ["Incumplimiento de los deberes de asistencia familiar"], "description": "List of strings to be used to whitelist crimes. If the value is found, the record  is ignored.", "items": {"type": "string"}, "title": "Crime Whitelist", "type": "array"}, "info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}}, "title": "AR National Fugitives Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__common__news_search__Settings": {"description": "Report settings for news_search report.", "properties": {"info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}}, "title": "Settings", "type": "object"}, "bgcapi__schemas__report_settings__common__sanctions__Settings": {"description": "Report settings for sanctions report.", "properties": {"name_score_min": {"default": 0.9, "description": "Minimum score for name match for a PASSED outcome (0.00 <= n <= 1.00).", "title": "Name Score Min", "type": "number"}, "show_ignored_records": {"default": false, "description": "Determine if ignored records are shown in the report details.", "title": "Show Ignored Records", "type": "boolean"}}, "title": "Sanctions Report Settings", "type": "object"}, "ReportEnable": {"description": "Enable or disable a report for a given person BGC.", "enum": ["enabled", "disabled"], "title": "ReportEnable", "type": "string"}, "Gender": {"description": "Possible gender for a given person BGC.", "enum": ["male", "female", "nonbinary"], "title": "Gender", "type": "string"}, "PersonPipeline": {"description": "Person pipeline details.", "properties": {"name": {"description": "Name of created pipeline.", "title": "Name", "type": "string"}}, "required": ["name"], "title": "Person Pipeline", "type": "object"}, "ReportSettings": {"description": "Report settings schema by report.", "properties": {"criminal_search": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__ar__criminal_search__Settings"}], "description": "Report settings for criminal_search report.", "title": "Criminal Search Report Settings"}, "federal_inmates": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__ar__federal_inmates__Settings"}], "description": "Report settings for federal_inmates report.", "title": "Federal Inmates Report Settings"}, "id_status": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__ar__id_status__Settings"}], "description": "Report settings for id_status report.", "title": "Id Status Report Settings"}, "name_check": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__name_check__Settings"}], "description": "Report settings for name_check report.", "title": "Name Check"}, "national_fugitives": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__ar__national_fugitives__Settings"}], "description": "Report settings for national_fugitives report.", "title": "National Fugitives Report Settings"}, "news_search": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__news_search__Settings"}], "description": "Report settings for news_search report.", "title": "News Search"}, "sanctions": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__sanctions__Settings"}], "description": "Sanctions Report Settings", "title": "Sanctions"}}, "title": "ReportSettings", "type": "object"}, "Reports": {"description": "Available reports for Argentina persons.", "properties": {"criminal_search": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Perform a search for criminal records for the given person.", "title": "Criminal Search", "x-depends-on-reports": []}, "federal_inmates": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Perform a search for sentenced records for the given person.", "title": "Federal Inmates", "x-depends-on-reports": []}, "id_status": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Check status of the given Document ID.", "title": "ID Status", "x-depends-on-reports": []}, "name_check": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks `full_name` provided against `full_name` registered. **Depends On** details from the `id_status` report(s).", "title": "Name Check", "x-depends-on-reports": ["id_status"]}, "national_fugitives": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Perform a search in Conarc and RNR for the given person.", "title": "National Fugitives", "x-depends-on-reports": []}, "news_search": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks criminal and non-criminal information about a person.", "title": "News Search", "x-depends-on-reports": []}, "sanctions": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks sanctions reports from UN, OFAC, EEAS and World Bank.", "title": "Sanctions", "x-depends-on-reports": []}}, "title": "Reports", "type": "object"}, "create_ar": {"definitions": {"Gender": {"description": "Possible gender for a given person BGC.", "enum": ["male", "female", "nonbinary"], "title": "Gender", "type": "string"}, "PersonPipeline": {"description": "Person pipeline details.", "properties": {"name": {"description": "Name of created pipeline.", "title": "Name", "type": "string"}}, "required": ["name"], "title": "Person Pipeline", "type": "object"}, "ReportEnable": {"description": "Enable or disable a report for a given person BGC.", "enum": ["enabled", "disabled"], "title": "ReportEnable", "type": "string"}, "ReportSettings": {"description": "Report settings schema by report.", "properties": {"criminal_search": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__ar__criminal_search__Settings"}], "description": "Report settings for criminal_search report.", "title": "Criminal Search Report Settings"}, "federal_inmates": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__ar__federal_inmates__Settings"}], "description": "Report settings for federal_inmates report.", "title": "Federal Inmates Report Settings"}, "id_status": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__ar__id_status__Settings"}], "description": "Report settings for id_status report.", "title": "Id Status Report Settings"}, "name_check": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__name_check__Settings"}], "description": "Report settings for name_check report.", "title": "Name Check"}, "national_fugitives": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__ar__national_fugitives__Settings"}], "description": "Report settings for national_fugitives report.", "title": "National Fugitives Report Settings"}, "news_search": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__news_search__Settings"}], "description": "Report settings for news_search report.", "title": "News Search"}, "sanctions": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__sanctions__Settings"}], "description": "Sanctions Report Settings", "title": "Sanctions"}}, "title": "ReportSettings", "type": "object"}, "Reports": {"description": "Available reports for Argentina persons.", "properties": {"criminal_search": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Perform a search for criminal records for the given person.", "title": "Criminal Search", "x-depends-on-reports": []}, "federal_inmates": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Perform a search for sentenced records for the given person.", "title": "Federal Inmates", "x-depends-on-reports": []}, "id_status": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Check status of the given Document ID.", "title": "ID Status", "x-depends-on-reports": []}, "name_check": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks `full_name` provided against `full_name` registered. **Depends On** details from the `id_status` report(s).", "title": "Name Check", "x-depends-on-reports": ["id_status"]}, "national_fugitives": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Perform a search in Conarc and RNR for the given person.", "title": "National Fugitives", "x-depends-on-reports": []}, "news_search": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks criminal and non-criminal information about a person.", "title": "News Search", "x-depends-on-reports": []}, "sanctions": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks sanctions reports from UN, OFAC, EEAS and World Bank.", "title": "Sanctions", "x-depends-on-reports": []}}, "title": "Reports", "type": "object"}, "SearchType": {"description": "Valid search types for criminal_search report.", "enum": ["forenames+surname", "document_id", "full_name"], "title": "SearchType", "type": "string"}, "SourceList": {"description": "Valid sources for criminal_search report.", "enum": ["boletin_pba", "boletin_rarg", "boletin_cba", "sentencias_cij", "boletin_pch", "boletin_corr", "boletin_rios", "boletin_mis", "boletin_neuq", "boletin_neg", "boletin_salt", "boletin_scz"], "title": "SourceList", "type": "string"}, "bgcapi__schemas__report_settings__ar__criminal_search__Settings": {"description": "Report settings schema for criminal_search report.", "properties": {"criminal_age_majority": {"description": "Records older than age of this person, will be ignored.", "title": "Criminal Age Majority", "type": "integer"}, "max_record_age_years": {"description": "Records older than this number of years will be ignored.", "title": "Max Record Age Years", "type": "integer"}, "name_score_min": {"default": 1, "description": "Minimum score for name match (0.00 <= n <= 1.00).", "title": "Name Score Min", "type": "number"}, "search_type": {"allOf": [{"$ref": "#/components/schemas/SearchType"}], "default": "full_name", "description": "Specific fields to be used while performing a search."}, "source_list": {"default": ["boletin_pba", "boletin_rarg", "boletin_cba", "sentencias_cij", "boletin_pch", "boletin_corr", "boletin_rios", "boletin_mis", "boletin_neuq", "boletin_neg", "boletin_salt", "boletin_scz"], "description": "Specific source to perform a search.", "items": {"$ref": "#/components/schemas/SourceList"}, "type": "array"}}, "title": "AR Criminal Search Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__ar__federal_inmates__Settings": {"description": "Report settings for federal_inmates report.", "properties": {"crime_whitelist": {"default": [], "description": "List of strings to be used to whitelist crimes. If the value is found, the record  is ignored.", "items": {"type": "string"}, "title": "Crime Whitelist", "type": "array"}, "info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}}, "title": "AR Federal Inmates Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__ar__id_status__Settings": {"description": "Report settings schema for id_status report.", "properties": {"invalid_dob_action": {"default": "INCOMPLETE", "description": "Action that should be taken if status is `invalid_dob`.", "enum": ["FAILED", "PASSED", "INCOMPLETE"], "title": "Invalid Dob Action", "type": "string"}, "invalid_document_id_action": {"default": "INCOMPLETE", "description": "Action that should be taken if status is `invalid_document_id`.", "enum": ["FAILED", "PASSED", "INCOMPLETE"], "title": "Invalid Document Id Action", "type": "string"}, "invalid_document_id_or_gender_action": {"default": "INCOMPLETE", "description": "Action that should be taken if status is `invalid_document_id_or_gender`.", "enum": ["FAILED", "PASSED", "INCOMPLETE"], "title": "Invalid Document Id Or Gender Action", "type": "string"}, "invalid_gender_action": {"default": "INCOMPLETE", "description": "Action that should be taken if status is `invalid_gender`.", "enum": ["FAILED", "PASSED", "INCOMPLETE"], "title": "Invalid Gender Action", "type": "string"}, "not_found_action": {"default": "INCOMPLETE", "description": "Action that should be taken if status is `not_found`.", "enum": ["FAILED", "PASSED", "INCOMPLETE"], "title": "Not Found Action", "type": "string"}}, "title": "AR Id Status Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__ar__national_fugitives__Settings": {"description": "Report settings for national_fugitives report.", "properties": {"crime_whitelist": {"default": ["Incumplimiento de los deberes de asistencia familiar"], "description": "List of strings to be used to whitelist crimes. If the value is found, the record  is ignored.", "items": {"type": "string"}, "title": "Crime Whitelist", "type": "array"}, "info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}}, "title": "AR National Fugitives Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__common__name_check__Settings": {"description": "Report settings for name_check report.", "properties": {"name_fragment_check": {"default": false, "description": "If the report should check for name fragments instead of full name check.", "title": "Name Fragment Check", "type": "boolean"}, "name_score_min": {"default": 1, "description": "Minimum score for name match for a PASSED outcome (0.00 <= n <= 1.00).", "title": "Name Score Min", "type": "number"}}, "title": "Name Check Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__common__news_search__Settings": {"description": "Report settings for news_search report.", "properties": {"info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}}, "title": "Settings", "type": "object"}, "bgcapi__schemas__report_settings__common__sanctions__Settings": {"description": "Report settings for sanctions report.", "properties": {"name_score_min": {"default": 0.9, "description": "Minimum score for name match for a PASSED outcome (0.00 <= n <= 1.00).", "title": "Name Score Min", "type": "number"}, "show_ignored_records": {"default": false, "description": "Determine if ignored records are shown in the report details.", "title": "Show Ignored Records", "type": "boolean"}}, "title": "Sanctions Report Settings", "type": "object"}}, "description": "Argentina Person Schema.", "properties": {"city_locode": {"description": "2 letter country code and 3 letter location code for the city a person is located in. See the LOCODE reference.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "dob": {"description": "ISO 8601 representation of the date the person was born. **Required** for `id_status`, `federal_inmates` **Optional** for `criminal_search`, `national_fugitives`", "type": "string", "x-optional-for-reports": ["criminal_search", "national_fugitives"], "x-required-by-reports": ["id_status", "federal_inmates"]}, "document_id": {"description": "Document ID Number for Argentina. **Required** for `id_status` **Optional** for `criminal_search`, `national_fugitives`, `name_check`, `reference_check`", "type": "string", "x-optional-for-reports": ["criminal_search", "national_fugitives", "name_check", "reference_check"], "x-required-by-reports": ["id_status"]}, "document_id_alt": {"description": "Alternate Document ID Number.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "document_id_type": {"anyOf": [{"enum": ["foreigner_card", "national_id"], "type": "string"}, {"type": "string"}], "description": "Document ID type.", "x-optional-for-reports": [], "x-required-by-reports": []}, "drivers_license_id": {"description": "Driver's license ID number.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "forenames": {"description": "Forenames of the person to be checked. **Required** for `federal_inmates`, `national_fugitives` **Optional** for `criminal_search`", "type": "string", "x-optional-for-reports": ["criminal_search"], "x-required-by-reports": ["federal_inmates", "national_fugitives"]}, "full_name": {"description": "Full Name of the person to be checked. **Required** for `sanctions`, `news_search` **Optional** for `criminal_search`, `sanctions`, `name_check`, `reference_check`", "type": "string", "x-optional-for-reports": ["criminal_search", "sanctions", "name_check", "reference_check"], "x-required-by-reports": ["sanctions", "news_search"]}, "gender": {"allOf": [{"$ref": "#/components/schemas/Gender"}], "description": "Gender for given person. **Required** for `id_status`", "x-optional-for-reports": [], "x-required-by-reports": ["id_status"]}, "phone": {"description": "Phone of the person to be checked.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "pipeline": {"allOf": [{"$ref": "#/components/schemas/PersonPipeline"}], "description": "Automatically enables reports and sets report_settings. It replaces `reports` and `report_settings` fields.", "x-optional-for-reports": [], "x-required-by-reports": []}, "report_settings": {"allOf": [{"$ref": "#/components/schemas/ReportSettings"}], "description": "Custom report_settings setup by report manually.", "x-optional-for-reports": [], "x-required-by-reports": []}, "reports": {"allOf": [{"$ref": "#/components/schemas/Reports"}], "description": "Custom report activation by enabling/disabling reports manually.", "x-optional-for-reports": [], "x-required-by-reports": []}, "surname": {"description": "Surname of the person to be checked. **Required** for `federal_inmates`, `national_fugitives` **Optional** for `criminal_search`", "type": "string", "x-optional-for-reports": ["criminal_search"], "x-required-by-reports": ["federal_inmates", "national_fugitives"]}, "webhook_details": {"description": "If true, the webhook will include the report details in the response.", "type": "boolean", "x-optional-for-reports": [], "x-required-by-reports": []}, "webhook_headers": {"additionalProperties": {"type": "string"}, "description": "Webhook headers to send in the request to the webhook URL.", "type": "object", "x-optional-for-reports": [], "x-required-by-reports": []}, "webhook_url": {"description": "Webhook URL to receive notifications when this person has a folder finished.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}}, "required": [], "title": "Argentina Person Schema", "type": "object"}, "CheckType": {"description": "Valid check types.", "enum": ["cpf", "rg", "full_name"], "title": "CheckType", "type": "string"}, "bgcapi__schemas__report_settings__br__state_records__Settings": {"description": "Report settings schema for state_records report.", "properties": {"age_majority": {"default": 1, "description": "Ignore files that were opened when the candidate was at a certain age. This includes files that were opened when the candidate had that age.", "title": "Age Majority", "type": "integer"}, "check_type": {"description": "Check sources with the respective person fields.", "items": {"$ref": "#/components/schemas/CheckType"}, "type": "array"}, "court_blacklist": {"description": "List of strings that are checked in the field `court`. Prevails over `court_whitelist`, to mark a record as revelant.", "items": {"type": "string"}, "title": "Court Blacklist", "type": "array"}, "court_whitelist": {"description": "List of allowed strings that are checked in the field `court`.", "items": {"type": "string"}, "title": "Court Whitelist", "type": "array"}, "info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}, "irrelevant_roles": {"description": "List of roles that are excluded for name matching.", "items": {"type": "string"}, "title": "Irrelevant Roles", "type": "array"}, "manual_review": {"default": false, "description": "Determines if the folder should go to manual review when there are non-dismissed records found.", "title": "Manual Review", "type": "boolean"}, "max_record_age_years": {"description": "Records older than this number of years will be ignored.", "title": "Max Record Age Years", "type": "integer"}, "name_score_min": {"default": 0, "description": "Minimum score for name match (0.00 <= n <= 1.00).", "title": "Name Score Min", "type": "number"}, "process_type_blacklist": {"description": "List of strings that are checked in the field `process_type`. Prevails over `process_type_whitelist`, to mark a record as revelant.", "items": {"type": "string"}, "title": "Process Type Blacklist", "type": "array"}, "process_type_whitelist": {"description": "List of allowed strings that are checked in the field `process_type`.", "items": {"type": "string"}, "title": "Process Type Whitelist", "type": "array"}, "subject_type_blacklist": {"description": "List of strings that are checked in the field `subject_type`. Prevails over `subject_type_whitelist`, to mark a record as revelant.", "items": {"type": "string"}, "title": "Subject Type Blacklist", "type": "array"}, "subject_type_whitelist": {"description": "List of allowed strings that are checked in the field `subject_type`.", "items": {"type": "string"}, "title": "Subject Type Whitelist", "type": "array"}, "uncategorized_status": {"default": "irrelevant", "description": "Default status for records if no other report settings are matched.", "enum": ["relevant", "irrelevant"], "title": "Uncategorized Status", "type": "string"}}, "title": "BR State Records Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__br__arrest_warrants__CheckTypes": {"description": "Valid check types.", "enum": ["cpf", "rg", "full_name"], "title": "CheckTypes", "type": "string"}, "bgcapi__schemas__report_settings__br__arrest_warrants__Settings": {"description": "Report settings schema for arrest_warrants report.", "properties": {"check_types": {"default": ["cpf"], "description": "Data that should be used in the arrest warrants search.", "items": {"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__arrest_warrants__CheckTypes"}, "type": "array"}, "manual_review": {"default": false, "description": "If Manual Review should be enabled for the report.", "title": "Manual Review", "type": "boolean"}}, "title": "BR Arrest Warrants Report Settings", "type": "object"}, "AllowedStatuses": {"description": "Valid status values.", "enum": ["REGULAR", "SUSPENSA", "TITULAR FALECIDO", "PENDENTE DE REGULARIZA\u00c7\u00c3O", "CANCELADA POR MULTIPLICIDADE", "NULA", "CANCELADA DE OF\u00cdCIO"], "title": "AllowedStatuses", "type": "string"}, "bgcapi__schemas__report_settings__br__cpf_status__Settings": {"description": "Report settings schema for cpf_status report.", "properties": {"allowed_statuses": {"default": ["REGULAR"], "description": "Status that are allowed for a PASSED outcome.", "items": {"$ref": "#/components/schemas/AllowedStatuses"}, "type": "array"}}, "title": "BR Cpf Status Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__br__criminal_records__CheckTypes": {"description": "Valid type values.", "enum": ["document_id", "full_name"], "title": "CheckTypes", "type": "string"}, "bgcapi__schemas__report_settings__br__criminal_records__Settings": {"description": "Report settings schema for criminal_records report.", "properties": {"check_types": {"default": ["document_id"], "description": "Data that should be used in the criminal records search.", "items": {"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__criminal_records__CheckTypes"}, "type": "array"}, "manual_review": {"default": false, "description": "If Manual Review should be enabled for the report.", "title": "Manual Review", "type": "boolean"}}, "title": "BR Criminal Records Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__br__detran_check__Settings": {"description": "Report settings schema for detran_check report.", "properties": {"info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}}, "title": "BR Detran Check Report Settings", "type": "object"}, "CpfStatus": {"description": "Valid CPF statuses.", "enum": ["regular", "suspensa", "pendente", "nula", "cancelada_1", "cancelada_2", "cancelada_3", "cancelada_4"], "title": "CpfStatus", "type": "string"}, "DriversLicenseAddress": {"description": "Schema of drivers license's address.", "properties": {"city_name": {"title": "City Name", "type": "string"}, "complement": {"title": "Complement", "type": "string"}, "district": {"title": "District", "type": "string"}, "number": {"title": "Number", "type": "string"}, "state": {"title": "State", "type": "string"}, "street": {"title": "Street", "type": "string"}, "zip_code": {"title": "Zip Code", "type": "string"}}, "title": "DriversLicenseAddress", "type": "object"}, "DriversLicenseDoc": {"description": "Schema of drivers license's doc.", "properties": {"id_number": {"title": "Id Number", "type": "string"}, "issuing_entity": {"title": "Issuing Entity", "type": "string"}, "issuing_state": {"title": "Issuing State", "type": "string"}, "type": {"title": "Type", "type": "string"}}, "title": "DriversLicenseDoc", "type": "object"}, "DriversLicenseInfo": {"description": "Schema of drivers license's info.", "properties": {"category": {"title": "Category", "type": "string"}, "drivers_license_number": {"title": "Drivers License Number", "type": "string"}, "expiration_date": {"title": "Expiration Date", "type": "string"}, "first_license_date": {"title": "First License Date", "type": "string"}, "foreigner_national_registry": {"title": "Foreigner National Registry", "type": "string"}, "has_impediment": {"title": "Has Impediment", "type": "boolean"}, "last_issued_date": {"title": "Last Issued Date", "type": "string"}, "status_code": {"title": "Status Code", "type": "string"}}, "title": "DriversLicenseInfo", "type": "object"}, "Nationality": {"description": "Valid nationalities.", "enum": ["brazilian", "naturalized_brazilian", "foreigner", "brazilian_born_abroad"], "title": "Nationality", "type": "string"}, "definitions-ReportSettings": {"description": "Report settings schema by report.", "properties": {"ac_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for ac_state_records report.", "title": "Ac State Records"}, "al_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for al_state_records report.", "title": "Al State Records"}, "am_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for am_state_records report.", "title": "Am State Records"}, "ap_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for ap_state_records report.", "title": "Ap State Records"}, "arrest_warrants": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__arrest_warrants__Settings"}], "description": "Report settings for arrest_warrants report.", "title": "Arrest Warrants"}, "ba_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for ba_state_records report.", "title": "Ba State Records"}, "ce_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for ce_state_records report.", "title": "Ce State Records"}, "cpf_status": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__cpf_status__Settings"}], "description": "Report settings for cpf_status report.", "title": "Cpf Status"}, "criminal_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__criminal_records__Settings"}], "description": "Report settings for criminal_records report.", "title": "Criminal Records"}, "detran_check": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__detran_check__Settings"}], "description": "Report settings for detran_check report.", "title": "Detran Check"}, "df_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for df_state_records report.", "title": "Df State Records"}, "es_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for es_state_records report.", "title": "Es State Records"}, "go_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for go_state_records report.", "title": "Go State Records"}, "ma_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for ma_state_records report.", "title": "Ma State Records"}, "mg_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for mg_state_records report.", "title": "Mg State Records"}, "ms_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for ms_state_records report.", "title": "Ms State Records"}, "mt_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for mt_state_records report.", "title": "Mt State Records"}, "name_check": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__name_check__Settings"}], "description": "Report settings for name_check report.", "title": "Name Check"}, "news_search": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__news_search__Settings"}], "description": "Report settings for news_search report.", "title": "News Search"}, "pa_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for pa_state_records report.", "title": "Pa State Records"}, "pb_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for pb_state_records report.", "title": "Pb State Records"}, "pe_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for pe_state_records report.", "title": "Pe State Records"}, "pi_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for pi_state_records report.", "title": "Pi State Records"}, "pr_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for pr_state_records report.", "title": "Pr State Records"}, "rj_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for rj_state_records report.", "title": "Rj State Records"}, "rn_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for rn_state_records report.", "title": "Rn State Records"}, "ro_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for ro_state_records report.", "title": "Ro State Records"}, "rr_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for rr_state_records report.", "title": "Rr State Records"}, "sanctions": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__sanctions__Settings"}], "description": "Sanctions Report Settings", "title": "Sanctions"}, "sc_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for sc_state_records report.", "title": "Sc State Records"}, "se_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for se_state_records report.", "title": "Se State Records"}, "sp_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for sp_state_records report.", "title": "Sp State Records"}}, "title": "ReportSettings", "type": "object"}, "definitions-Reports": {"description": "Available reports for Brazil persons.", "properties": {"ac_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Acre state court (TJAC).", "title": "AC State Records", "x-depends-on-reports": []}, "al_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Alagoas state court (TJAL).", "title": "AL State Records", "x-depends-on-reports": []}, "am_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Amazonas state court (TJAM).", "title": "AM State Records", "x-depends-on-reports": []}, "ap_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Amap\u00e1 state court (TJAP).", "title": "AP State Records", "x-depends-on-reports": []}, "arrest_warrants": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks for arrest warrants at the *Arrest Warrants National Records* (BNMP). **Depends On** details from the `cpf_status` report(s).", "title": "Arrest Warrants", "x-depends-on-reports": ["cpf_status"]}, "ba_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Bahia state court (TJBA).", "title": "BA State Records", "x-depends-on-reports": []}, "ce_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Cear\u00e1 state court (TJCE).", "title": "CE State Records", "x-depends-on-reports": []}, "cpf_status": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Validates a CPF number (`document_id`) and retrieves the personal data from Receita Federal database.", "title": "Cpf Status", "x-depends-on-reports": []}, "criminal_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks for criminal records at the *Unified Electronic Executions System* (SEEU). **Depends On** details from the `cpf_status` report(s).", "title": "Criminal Records", "x-depends-on-reports": ["cpf_status"]}, "detran_check": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "This report is deprecated.", "title": "SERPRO Detran Check", "x-depends-on-reports": []}, "df_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Distrito Federal state court (TJDF).", "title": "DF State Records", "x-depends-on-reports": []}, "dob_check": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks `dob` provided against `dob` registered in the Receita Federal database. **Depends On** details from the `cpf_status` report(s).", "title": "Date of birth Check", "x-depends-on-reports": ["cpf_status"]}, "es_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Esp\u00edrito Santo state court (TJES).", "title": "ES State Records", "x-depends-on-reports": []}, "esocial": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "This report is deprecated.", "title": "eSocial Registry", "x-depends-on-reports": []}, "go_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Goi\u00e1s state court (TJGO).", "title": "GO State Records", "x-depends-on-reports": []}, "ma_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Maranh\u00e3o state court (TJMA).", "title": "MA State Records", "x-depends-on-reports": []}, "mg_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Minas Gerais state court (TJMG).", "title": "MG State Records", "x-depends-on-reports": []}, "ms_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Mato Grosso do Sul state court (TJMS).", "title": "MS State Records", "x-depends-on-reports": []}, "mt_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Mato Grosso state court (TJMT).", "title": "MT State Records", "x-depends-on-reports": []}, "name_check": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks `full_name` provided against `full_name` registered. **Depends On** details from the `cpf_status` report(s).", "title": "Name Check", "x-depends-on-reports": ["cpf_status"]}, "national_criminal_record": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Deprecated report.", "title": "National Criminal Record", "x-depends-on-reports": []}, "news_search": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks criminal and non-criminal information about a person.", "title": "News Search", "x-depends-on-reports": []}, "pa_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Par\u00e1 state court (TJPA).", "title": "PA State Records", "x-depends-on-reports": []}, "pb_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Para\u00edba state court (TJPB).", "title": "PB State Records", "x-depends-on-reports": []}, "pe_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Pernambuco state court (TJPE).", "title": "PE State Records", "x-depends-on-reports": []}, "pi_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Piau\u00ed state court (TJPI).", "title": "PI State Records", "x-depends-on-reports": []}, "police_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Federal Police for a negative criminal certificate. **Depends On** details from the `cpf_status` report(s).", "title": "Police Records", "x-depends-on-reports": ["cpf_status"]}, "pr_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Paran\u00e1 state court (TJPR).", "title": "PR State Records", "x-depends-on-reports": []}, "rj_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Rio de Janeiro state court (TJRJ).", "title": "RJ State Records", "x-depends-on-reports": []}, "rn_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Rio Grande do Norte state court (TJRN).", "title": "RN State Records", "x-depends-on-reports": []}, "ro_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Rond\u00f4nia state court (TJRO).", "title": "RO State Records", "x-depends-on-reports": []}, "rr_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Roraima state court (TJRR).", "title": "RR State Records", "x-depends-on-reports": []}, "sanctions": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks sanctions reports from UN, OFAC, EEAS and World Bank. **Depends On** details from the `cpf_status` report(s).", "title": "Sanctions", "x-depends-on-reports": ["cpf_status"]}, "sc_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Santa Catarina state court (TJSC).", "title": "SC State Records", "x-depends-on-reports": []}, "se_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Sergipe state court (TJSE).", "title": "SE State Records", "x-depends-on-reports": []}, "sp_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in S\u00e3o Paulo state court (TJSP).", "title": "SP State Records", "x-depends-on-reports": []}}, "title": "Reports", "type": "object"}, "create_br": {"definitions": {"AllowedStatuses": {"description": "Valid status values.", "enum": ["REGULAR", "SUSPENSA", "TITULAR FALECIDO", "PENDENTE DE REGULARIZA\u00c7\u00c3O", "CANCELADA POR MULTIPLICIDADE", "NULA", "CANCELADA DE OF\u00cdCIO"], "title": "AllowedStatuses", "type": "string"}, "CheckType": {"description": "Valid check types.", "enum": ["cpf", "rg", "full_name"], "title": "CheckType", "type": "string"}, "CpfStatus": {"description": "Valid CPF statuses.", "enum": ["regular", "suspensa", "pendente", "nula", "cancelada_1", "cancelada_2", "cancelada_3", "cancelada_4"], "title": "CpfStatus", "type": "string"}, "DriversLicenseAddress": {"description": "Schema of drivers license's address.", "properties": {"city_name": {"title": "City Name", "type": "string"}, "complement": {"title": "Complement", "type": "string"}, "district": {"title": "District", "type": "string"}, "number": {"title": "Number", "type": "string"}, "state": {"title": "State", "type": "string"}, "street": {"title": "Street", "type": "string"}, "zip_code": {"title": "Zip Code", "type": "string"}}, "title": "DriversLicenseAddress", "type": "object"}, "DriversLicenseDoc": {"description": "Schema of drivers license's doc.", "properties": {"id_number": {"title": "Id Number", "type": "string"}, "issuing_entity": {"title": "Issuing Entity", "type": "string"}, "issuing_state": {"title": "Issuing State", "type": "string"}, "type": {"title": "Type", "type": "string"}}, "title": "DriversLicenseDoc", "type": "object"}, "DriversLicenseInfo": {"description": "Schema of drivers license's info.", "properties": {"category": {"title": "Category", "type": "string"}, "drivers_license_number": {"title": "Drivers License Number", "type": "string"}, "expiration_date": {"title": "Expiration Date", "type": "string"}, "first_license_date": {"title": "First License Date", "type": "string"}, "foreigner_national_registry": {"title": "Foreigner National Registry", "type": "string"}, "has_impediment": {"title": "Has Impediment", "type": "boolean"}, "last_issued_date": {"title": "Last Issued Date", "type": "string"}, "status_code": {"title": "Status Code", "type": "string"}}, "title": "DriversLicenseInfo", "type": "object"}, "Nationality": {"description": "Valid nationalities.", "enum": ["brazilian", "naturalized_brazilian", "foreigner", "brazilian_born_abroad"], "title": "Nationality", "type": "string"}, "PersonPipeline": {"description": "Person pipeline details.", "properties": {"name": {"description": "Name of created pipeline.", "title": "Name", "type": "string"}}, "required": ["name"], "title": "Person Pipeline", "type": "object"}, "ReportEnable": {"description": "Enable or disable a report for a given person BGC.", "enum": ["enabled", "disabled"], "title": "ReportEnable", "type": "string"}, "ReportSettings": {"description": "Report settings schema by report.", "properties": {"ac_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for ac_state_records report.", "title": "Ac State Records"}, "al_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for al_state_records report.", "title": "Al State Records"}, "am_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for am_state_records report.", "title": "Am State Records"}, "ap_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for ap_state_records report.", "title": "Ap State Records"}, "arrest_warrants": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__arrest_warrants__Settings"}], "description": "Report settings for arrest_warrants report.", "title": "Arrest Warrants"}, "ba_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for ba_state_records report.", "title": "Ba State Records"}, "ce_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for ce_state_records report.", "title": "Ce State Records"}, "cpf_status": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__cpf_status__Settings"}], "description": "Report settings for cpf_status report.", "title": "Cpf Status"}, "criminal_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__criminal_records__Settings"}], "description": "Report settings for criminal_records report.", "title": "Criminal Records"}, "detran_check": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__detran_check__Settings"}], "description": "Report settings for detran_check report.", "title": "Detran Check"}, "df_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for df_state_records report.", "title": "Df State Records"}, "es_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for es_state_records report.", "title": "Es State Records"}, "go_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for go_state_records report.", "title": "Go State Records"}, "ma_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for ma_state_records report.", "title": "Ma State Records"}, "mg_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for mg_state_records report.", "title": "Mg State Records"}, "ms_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for ms_state_records report.", "title": "Ms State Records"}, "mt_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for mt_state_records report.", "title": "Mt State Records"}, "name_check": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__name_check__Settings"}], "description": "Report settings for name_check report.", "title": "Name Check"}, "news_search": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__news_search__Settings"}], "description": "Report settings for news_search report.", "title": "News Search"}, "pa_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for pa_state_records report.", "title": "Pa State Records"}, "pb_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for pb_state_records report.", "title": "Pb State Records"}, "pe_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for pe_state_records report.", "title": "Pe State Records"}, "pi_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for pi_state_records report.", "title": "Pi State Records"}, "pr_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for pr_state_records report.", "title": "Pr State Records"}, "rj_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for rj_state_records report.", "title": "Rj State Records"}, "rn_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for rn_state_records report.", "title": "Rn State Records"}, "ro_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for ro_state_records report.", "title": "Ro State Records"}, "rr_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for rr_state_records report.", "title": "Rr State Records"}, "sanctions": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__sanctions__Settings"}], "description": "Sanctions Report Settings", "title": "Sanctions"}, "sc_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for sc_state_records report.", "title": "Sc State Records"}, "se_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for se_state_records report.", "title": "Se State Records"}, "sp_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for sp_state_records report.", "title": "Sp State Records"}}, "title": "ReportSettings", "type": "object"}, "Reports": {"description": "Available reports for Brazil persons.", "properties": {"ac_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Acre state court (TJAC).", "title": "AC State Records", "x-depends-on-reports": []}, "al_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Alagoas state court (TJAL).", "title": "AL State Records", "x-depends-on-reports": []}, "am_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Amazonas state court (TJAM).", "title": "AM State Records", "x-depends-on-reports": []}, "ap_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Amap\u00e1 state court (TJAP).", "title": "AP State Records", "x-depends-on-reports": []}, "arrest_warrants": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks for arrest warrants at the *Arrest Warrants National Records* (BNMP). **Depends On** details from the `cpf_status` report(s).", "title": "Arrest Warrants", "x-depends-on-reports": ["cpf_status"]}, "ba_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Bahia state court (TJBA).", "title": "BA State Records", "x-depends-on-reports": []}, "ce_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Cear\u00e1 state court (TJCE).", "title": "CE State Records", "x-depends-on-reports": []}, "cpf_status": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Validates a CPF number (`document_id`) and retrieves the personal data from Receita Federal database.", "title": "Cpf Status", "x-depends-on-reports": []}, "criminal_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks for criminal records at the *Unified Electronic Executions System* (SEEU). **Depends On** details from the `cpf_status` report(s).", "title": "Criminal Records", "x-depends-on-reports": ["cpf_status"]}, "detran_check": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "This report is deprecated.", "title": "SERPRO Detran Check", "x-depends-on-reports": []}, "df_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Distrito Federal state court (TJDF).", "title": "DF State Records", "x-depends-on-reports": []}, "dob_check": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks `dob` provided against `dob` registered in the Receita Federal database. **Depends On** details from the `cpf_status` report(s).", "title": "Date of birth Check", "x-depends-on-reports": ["cpf_status"]}, "es_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Esp\u00edrito Santo state court (TJES).", "title": "ES State Records", "x-depends-on-reports": []}, "esocial": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "This report is deprecated.", "title": "eSocial Registry", "x-depends-on-reports": []}, "go_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Goi\u00e1s state court (TJGO).", "title": "GO State Records", "x-depends-on-reports": []}, "ma_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Maranh\u00e3o state court (TJMA).", "title": "MA State Records", "x-depends-on-reports": []}, "mg_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Minas Gerais state court (TJMG).", "title": "MG State Records", "x-depends-on-reports": []}, "ms_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Mato Grosso do Sul state court (TJMS).", "title": "MS State Records", "x-depends-on-reports": []}, "mt_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Mato Grosso state court (TJMT).", "title": "MT State Records", "x-depends-on-reports": []}, "name_check": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks `full_name` provided against `full_name` registered. **Depends On** details from the `cpf_status` report(s).", "title": "Name Check", "x-depends-on-reports": ["cpf_status"]}, "national_criminal_record": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Deprecated report.", "title": "National Criminal Record", "x-depends-on-reports": []}, "news_search": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks criminal and non-criminal information about a person.", "title": "News Search", "x-depends-on-reports": []}, "pa_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Par\u00e1 state court (TJPA).", "title": "PA State Records", "x-depends-on-reports": []}, "pb_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Para\u00edba state court (TJPB).", "title": "PB State Records", "x-depends-on-reports": []}, "pe_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Pernambuco state court (TJPE).", "title": "PE State Records", "x-depends-on-reports": []}, "pi_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Piau\u00ed state court (TJPI).", "title": "PI State Records", "x-depends-on-reports": []}, "police_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Federal Police for a negative criminal certificate. **Depends On** details from the `cpf_status` report(s).", "title": "Police Records", "x-depends-on-reports": ["cpf_status"]}, "pr_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Paran\u00e1 state court (TJPR).", "title": "PR State Records", "x-depends-on-reports": []}, "rj_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Rio de Janeiro state court (TJRJ).", "title": "RJ State Records", "x-depends-on-reports": []}, "rn_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Rio Grande do Norte state court (TJRN).", "title": "RN State Records", "x-depends-on-reports": []}, "ro_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Rond\u00f4nia state court (TJRO).", "title": "RO State Records", "x-depends-on-reports": []}, "rr_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Roraima state court (TJRR).", "title": "RR State Records", "x-depends-on-reports": []}, "sanctions": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks sanctions reports from UN, OFAC, EEAS and World Bank. **Depends On** details from the `cpf_status` report(s).", "title": "Sanctions", "x-depends-on-reports": ["cpf_status"]}, "sc_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Santa Catarina state court (TJSC).", "title": "SC State Records", "x-depends-on-reports": []}, "se_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Sergipe state court (TJSE).", "title": "SE State Records", "x-depends-on-reports": []}, "sp_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in S\u00e3o Paulo state court (TJSP).", "title": "SP State Records", "x-depends-on-reports": []}}, "title": "Reports", "type": "object"}, "bgcapi__schemas__report_settings__br__arrest_warrants__CheckTypes": {"description": "Valid check types.", "enum": ["cpf", "rg", "full_name"], "title": "CheckTypes", "type": "string"}, "bgcapi__schemas__report_settings__br__arrest_warrants__Settings": {"description": "Report settings schema for arrest_warrants report.", "properties": {"check_types": {"default": ["cpf"], "description": "Data that should be used in the arrest warrants search.", "items": {"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__arrest_warrants__CheckTypes"}, "type": "array"}, "manual_review": {"default": false, "description": "If Manual Review should be enabled for the report.", "title": "Manual Review", "type": "boolean"}}, "title": "BR Arrest Warrants Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__br__cpf_status__Settings": {"description": "Report settings schema for cpf_status report.", "properties": {"allowed_statuses": {"default": ["REGULAR"], "description": "Status that are allowed for a PASSED outcome.", "items": {"$ref": "#/components/schemas/AllowedStatuses"}, "type": "array"}}, "title": "BR Cpf Status Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__br__criminal_records__CheckTypes": {"description": "Valid type values.", "enum": ["document_id", "full_name"], "title": "CheckTypes", "type": "string"}, "bgcapi__schemas__report_settings__br__criminal_records__Settings": {"description": "Report settings schema for criminal_records report.", "properties": {"check_types": {"default": ["document_id"], "description": "Data that should be used in the criminal records search.", "items": {"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__criminal_records__CheckTypes"}, "type": "array"}, "manual_review": {"default": false, "description": "If Manual Review should be enabled for the report.", "title": "Manual Review", "type": "boolean"}}, "title": "BR Criminal Records Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__br__detran_check__Settings": {"description": "Report settings schema for detran_check report.", "properties": {"info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}}, "title": "BR Detran Check Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__br__state_records__Settings": {"description": "Report settings schema for state_records report.", "properties": {"age_majority": {"default": 1, "description": "Ignore files that were opened when the candidate was at a certain age. This includes files that were opened when the candidate had that age.", "title": "Age Majority", "type": "integer"}, "check_type": {"description": "Check sources with the respective person fields.", "items": {"$ref": "#/components/schemas/CheckType"}, "type": "array"}, "court_blacklist": {"description": "List of strings that are checked in the field `court`. Prevails over `court_whitelist`, to mark a record as revelant.", "items": {"type": "string"}, "title": "Court Blacklist", "type": "array"}, "court_whitelist": {"description": "List of allowed strings that are checked in the field `court`.", "items": {"type": "string"}, "title": "Court Whitelist", "type": "array"}, "info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}, "irrelevant_roles": {"description": "List of roles that are excluded for name matching.", "items": {"type": "string"}, "title": "Irrelevant Roles", "type": "array"}, "manual_review": {"default": false, "description": "Determines if the folder should go to manual review when there are non-dismissed records found.", "title": "Manual Review", "type": "boolean"}, "max_record_age_years": {"description": "Records older than this number of years will be ignored.", "title": "Max Record Age Years", "type": "integer"}, "name_score_min": {"default": 0, "description": "Minimum score for name match (0.00 <= n <= 1.00).", "title": "Name Score Min", "type": "number"}, "process_type_blacklist": {"description": "List of strings that are checked in the field `process_type`. Prevails over `process_type_whitelist`, to mark a record as revelant.", "items": {"type": "string"}, "title": "Process Type Blacklist", "type": "array"}, "process_type_whitelist": {"description": "List of allowed strings that are checked in the field `process_type`.", "items": {"type": "string"}, "title": "Process Type Whitelist", "type": "array"}, "subject_type_blacklist": {"description": "List of strings that are checked in the field `subject_type`. Prevails over `subject_type_whitelist`, to mark a record as revelant.", "items": {"type": "string"}, "title": "Subject Type Blacklist", "type": "array"}, "subject_type_whitelist": {"description": "List of allowed strings that are checked in the field `subject_type`.", "items": {"type": "string"}, "title": "Subject Type Whitelist", "type": "array"}, "uncategorized_status": {"default": "irrelevant", "description": "Default status for records if no other report settings are matched.", "enum": ["relevant", "irrelevant"], "title": "Uncategorized Status", "type": "string"}}, "title": "BR State Records Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__common__name_check__Settings": {"description": "Report settings for name_check report.", "properties": {"name_fragment_check": {"default": false, "description": "If the report should check for name fragments instead of full name check.", "title": "Name Fragment Check", "type": "boolean"}, "name_score_min": {"default": 1, "description": "Minimum score for name match for a PASSED outcome (0.00 <= n <= 1.00).", "title": "Name Score Min", "type": "number"}}, "title": "Name Check Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__common__news_search__Settings": {"description": "Report settings for news_search report.", "properties": {"info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}}, "title": "Settings", "type": "object"}, "bgcapi__schemas__report_settings__common__sanctions__Settings": {"description": "Report settings for sanctions report.", "properties": {"name_score_min": {"default": 0.9, "description": "Minimum score for name match for a PASSED outcome (0.00 <= n <= 1.00).", "title": "Name Score Min", "type": "number"}, "show_ignored_records": {"default": false, "description": "Determine if ignored records are shown in the report details.", "title": "Show Ignored Records", "type": "boolean"}}, "title": "Sanctions Report Settings", "type": "object"}}, "description": "Brazil Person Schema.", "properties": {"address_city": {"description": "Person's address city.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "address_number": {"description": "Person's address number.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "address_postal_code": {"description": "Person's address postal code.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "address_state": {"description": "Person's address state.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "address_street": {"description": "Person's address street.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "city_locode": {"description": "2 letter country code and 3 letter location code for the city a person is located in. See the LOCODE reference.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "cpf_status": {"allOf": [{"$ref": "#/components/schemas/CpfStatus"}], "description": "Person's CPF status.", "x-optional-for-reports": [], "x-required-by-reports": []}, "dob": {"description": "ISO 8601 representation of the date the person was born. **Required** for `dob_check` **Optional** for `cpf_status`, `police_records`, `ac_state_records`, `al_state_records`, `am_state_records`, `ap_state_records`, `ba_state_records`, `ce_state_records`, `df_state_records`, `es_state_records`, `go_state_records`, `ma_state_records`, `mg_state_records`, `ms_state_records`, `mt_state_records`, `pa_state_records`, `pb_state_records`, `pe_state_records`, `pi_state_records`, `pr_state_records`, `rj_state_records`, `rn_state_records`, `ro_state_records`, `rr_state_records`, `sc_state_records`, `se_state_records`, `sp_state_records`", "type": "string", "x-optional-for-reports": ["cpf_status", "police_records", "ac_state_records", "al_state_records", "am_state_records", "ap_state_records", "ba_state_records", "ce_state_records", "df_state_records", "es_state_records", "go_state_records", "ma_state_records", "mg_state_records", "ms_state_records", "mt_state_records", "pa_state_records", "pb_state_records", "pe_state_records", "pi_state_records", "pr_state_records", "rj_state_records", "rn_state_records", "ro_state_records", "rr_state_records", "sc_state_records", "se_state_records", "sp_state_records"], "x-required-by-reports": ["dob_check"]}, "document_id": {"description": "Document ID Number for Brazil. *Cadastro de Pessoa F\u00edsica (CPF)* digits. **Required** for `cpf_status`, `dob_check`, `police_records`, `criminal_records`, `sanctions` **Optional** for `name_check`, `arrest_warrants`, `reference_check`, `ac_state_records`, `al_state_records`, `am_state_records`, `ap_state_records`, `ba_state_records`, `ce_state_records`, `df_state_records`, `es_state_records`, `go_state_records`, `ma_state_records`, `mg_state_records`, `ms_state_records`, `mt_state_records`, `pa_state_records`, `pb_state_records`, `pe_state_records`, `pi_state_records`, `pr_state_records`, `rj_state_records`, `rn_state_records`, `ro_state_records`, `rr_state_records`, `sc_state_records`, `se_state_records`, `sp_state_records`", "type": "string", "x-optional-for-reports": ["name_check", "arrest_warrants", "reference_check", "ac_state_records", "al_state_records", "am_state_records", "ap_state_records", "ba_state_records", "ce_state_records", "df_state_records", "es_state_records", "go_state_records", "ma_state_records", "mg_state_records", "ms_state_records", "mt_state_records", "pa_state_records", "pb_state_records", "pe_state_records", "pi_state_records", "pr_state_records", "rj_state_records", "rn_state_records", "ro_state_records", "rr_state_records", "sc_state_records", "se_state_records", "sp_state_records"], "x-required-by-reports": ["cpf_status", "dob_check", "police_records", "criminal_records", "sanctions"]}, "document_id_alt": {"description": "Alternate Document ID Number. **Optional** for `arrest_warrants`, `ac_state_records`, `al_state_records`, `am_state_records`, `ap_state_records`, `ba_state_records`, `ce_state_records`, `df_state_records`, `es_state_records`, `go_state_records`, `ma_state_records`, `mg_state_records`, `ms_state_records`, `mt_state_records`, `pa_state_records`, `pb_state_records`, `pe_state_records`, `pi_state_records`, `pr_state_records`, `rj_state_records`, `rn_state_records`, `ro_state_records`, `rr_state_records`, `sc_state_records`, `se_state_records`, `sp_state_records`", "type": "string", "x-optional-for-reports": ["arrest_warrants", "ac_state_records", "al_state_records", "am_state_records", "ap_state_records", "ba_state_records", "ce_state_records", "df_state_records", "es_state_records", "go_state_records", "ma_state_records", "mg_state_records", "ms_state_records", "mt_state_records", "pa_state_records", "pb_state_records", "pe_state_records", "pi_state_records", "pr_state_records", "rj_state_records", "rn_state_records", "ro_state_records", "rr_state_records", "sc_state_records", "se_state_records", "sp_state_records"], "x-required-by-reports": []}, "document_id_type": {"anyOf": [{"enum": ["foreigner_card", "national_id"], "type": "string"}, {"type": "string"}], "description": "Document ID type.", "x-optional-for-reports": [], "x-required-by-reports": []}, "drivers_license_address": {"allOf": [{"$ref": "#/components/schemas/DriversLicenseAddress"}], "description": "Person's drivers license address.", "x-optional-for-reports": [], "x-required-by-reports": []}, "drivers_license_doc": {"allOf": [{"$ref": "#/components/schemas/DriversLicenseDoc"}], "description": "Person's drivers license document.", "x-optional-for-reports": [], "x-required-by-reports": []}, "drivers_license_id": {"description": "Driver's license ID number.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "drivers_license_info": {"allOf": [{"$ref": "#/components/schemas/DriversLicenseInfo"}], "description": "Person's drivers license information.", "x-optional-for-reports": [], "x-required-by-reports": []}, "fathers_full_name": {"description": "Full Name of the Person's father. If provided, it's used for homonyms check.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "forenames": {"description": "Forenames of the person to be checked.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "full_name": {"description": "Full Name of the person to be checked. **Optional** for `name_check`, `police_records`, `arrest_warrants`, `criminal_records`, `sanctions`, `news_search`, `reference_check`, `ac_state_records`, `al_state_records`, `am_state_records`, `ap_state_records`, `ba_state_records`, `ce_state_records`, `df_state_records`, `es_state_records`, `go_state_records`, `ma_state_records`, `mg_state_records`, `ms_state_records`, `mt_state_records`, `pa_state_records`, `pb_state_records`, `pe_state_records`, `pi_state_records`, `pr_state_records`, `rj_state_records`, `rn_state_records`, `ro_state_records`, `rr_state_records`, `sc_state_records`, `se_state_records`, `sp_state_records`", "type": "string", "x-optional-for-reports": ["name_check", "police_records", "arrest_warrants", "criminal_records", "sanctions", "news_search", "reference_check", "ac_state_records", "al_state_records", "am_state_records", "ap_state_records", "ba_state_records", "ce_state_records", "df_state_records", "es_state_records", "go_state_records", "ma_state_records", "mg_state_records", "ms_state_records", "mt_state_records", "pa_state_records", "pb_state_records", "pe_state_records", "pi_state_records", "pr_state_records", "rj_state_records", "rn_state_records", "ro_state_records", "rr_state_records", "sc_state_records", "se_state_records", "sp_state_records"], "x-required-by-reports": []}, "gender": {"description": "Person's gender", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "mothers_full_name": {"description": "Full Name of the Person's mother. If provided, it's used for homonyms check.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "nationality": {"allOf": [{"$ref": "#/components/schemas/Nationality"}], "description": "Person's nationality.", "x-optional-for-reports": [], "x-required-by-reports": []}, "phone": {"description": "Phone of the person to be checked.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "pipeline": {"allOf": [{"$ref": "#/components/schemas/PersonPipeline"}], "description": "Automatically enables reports and sets report_settings. It replaces `reports` and `report_settings` fields.", "x-optional-for-reports": [], "x-required-by-reports": []}, "report_settings": {"allOf": [{"$ref": "#/components/schemas/definitions-ReportSettings"}], "description": "Custom report_settings setup by report manually.", "x-optional-for-reports": [], "x-required-by-reports": []}, "reports": {"allOf": [{"$ref": "#/components/schemas/definitions-Reports"}], "description": "Custom report activation by enabling/disabling reports manually.", "x-optional-for-reports": [], "x-required-by-reports": []}, "social_security_id": {"description": "Person's social security id", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "surname": {"description": "Surname of the person to be checked.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "webhook_details": {"description": "If true, the webhook will include the report details in the response.", "type": "boolean", "x-optional-for-reports": [], "x-required-by-reports": []}, "webhook_headers": {"additionalProperties": {"type": "string"}, "description": "Webhook headers to send in the request to the webhook URL.", "type": "object", "x-optional-for-reports": [], "x-required-by-reports": []}, "webhook_url": {"description": "Webhook URL to receive notifications when this person has a folder finished.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}}, "required": ["city_locode"], "title": "Brazil Person Schema", "type": "object"}, "bgcapi__schemas__report_settings__cl__mtt_taxi__Settings": {"description": "Report settings schema for mtt_taxi report.", "properties": {"allowed_statuses": {"default": ["VIGENTE"], "description": "Status that are allowed for a PASSED outcome.", "items": {"type": "string"}, "title": "Allowed Statuses", "type": "array"}}, "title": "CL Mtt Taxi Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__cl__vehicle_check__Settings": {"description": "Report settings schema for vehicle_check report.", "properties": {"car_years_max": {"default": 20, "description": "Maximum age of the car (in years)", "title": "Car Years Max", "type": "integer"}, "ignore_recent_not_found": {"default": true, "description": "Recently issued plates sometimes can't be queried, but they use sequential letters. This setting allows approving very recent plates even if they are not found.", "title": "Ignore Recent Not Found", "type": "boolean"}, "not_found_action": {"default": "INCOMPLETE", "description": "Action that should be taken if license plate is `not_found`.", "enum": ["FAILED", "PASSED", "INCOMPLETE"], "title": "Not Found Action", "type": "string"}, "unpaid_permit_action": {"default": "PASSED", "description": "Action that should be taken if license plate does not have a paid circulation permit", "enum": ["FAILED", "PASSED"], "title": "Unpaid Permit Action", "type": "string"}}, "title": "CL Vehicle Check Report Settings", "type": "object"}, "create_cl_definitions-ReportSettings": {"description": "Report settings schema by report.", "properties": {"mtt_taxi": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__cl__mtt_taxi__Settings"}], "description": "Report settings for mtt_taxi report.", "title": "Mtt Taxi"}, "name_check": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__name_check__Settings"}], "description": "Report settings for name_check report.", "title": "Name Check"}, "news_search": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__news_search__Settings"}], "description": "Report settings for news_search report.", "title": "News Search"}, "sanctions": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__sanctions__Settings"}], "description": "Sanctions Report Settings", "title": "Sanctions"}, "vehicle_check": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__cl__vehicle_check__Settings"}], "description": "Report settings for vehicle_check report.", "title": "Vehicle Check"}}, "title": "ReportSettings", "type": "object"}, "create_cl_definitions-Reports": {"description": "Available reports for Chile persons.", "properties": {"criminal": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks courts for criminal records.", "title": "Criminal", "x-depends-on-reports": []}, "justice_certificate": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Retrieves and checks Justice Certificate.", "title": "Justice Certificate", "x-depends-on-reports": []}, "license_status": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Driver's License status.", "title": "License Status", "x-depends-on-reports": []}, "mtt_taxi": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Retrieves all data available for the provided `license_plate`.", "title": "MTT Taxi", "x-depends-on-reports": []}, "name_check": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks `full_name` provided against `full_name` registered. **Depends On** details from the `run_status` report(s).", "title": "Name Check", "x-depends-on-reports": ["run_status"]}, "news_search": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks criminal and non-criminal information about a person.", "title": "News Search", "x-depends-on-reports": []}, "run_status": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks RUN (`document_id`) status.", "title": "Run Status", "x-depends-on-reports": []}, "sanctions": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks sanctions reports from UN, OFAC, EEAS and World Bank. **Depends On** details from the `run_status` report(s).", "title": "Sanctions", "x-depends-on-reports": ["run_status"]}, "vehicle_check": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Retrieves all data available for the provided `license_plate`.", "title": "Vehicle Check", "x-depends-on-reports": []}}, "title": "Reports", "type": "object"}, "create_cl": {"definitions": {"PersonPipeline": {"description": "Person pipeline details.", "properties": {"name": {"description": "Name of created pipeline.", "title": "Name", "type": "string"}}, "required": ["name"], "title": "Person Pipeline", "type": "object"}, "ReportEnable": {"description": "Enable or disable a report for a given person BGC.", "enum": ["enabled", "disabled"], "title": "ReportEnable", "type": "string"}, "ReportSettings": {"description": "Report settings schema by report.", "properties": {"mtt_taxi": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__cl__mtt_taxi__Settings"}], "description": "Report settings for mtt_taxi report.", "title": "Mtt Taxi"}, "name_check": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__name_check__Settings"}], "description": "Report settings for name_check report.", "title": "Name Check"}, "news_search": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__news_search__Settings"}], "description": "Report settings for news_search report.", "title": "News Search"}, "sanctions": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__sanctions__Settings"}], "description": "Sanctions Report Settings", "title": "Sanctions"}, "vehicle_check": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__cl__vehicle_check__Settings"}], "description": "Report settings for vehicle_check report.", "title": "Vehicle Check"}}, "title": "ReportSettings", "type": "object"}, "Reports": {"description": "Available reports for Chile persons.", "properties": {"criminal": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks courts for criminal records.", "title": "Criminal", "x-depends-on-reports": []}, "justice_certificate": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Retrieves and checks Justice Certificate.", "title": "Justice Certificate", "x-depends-on-reports": []}, "license_status": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Driver's License status.", "title": "License Status", "x-depends-on-reports": []}, "mtt_taxi": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Retrieves all data available for the provided `license_plate`.", "title": "MTT Taxi", "x-depends-on-reports": []}, "name_check": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks `full_name` provided against `full_name` registered. **Depends On** details from the `run_status` report(s).", "title": "Name Check", "x-depends-on-reports": ["run_status"]}, "news_search": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks criminal and non-criminal information about a person.", "title": "News Search", "x-depends-on-reports": []}, "run_status": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks RUN (`document_id`) status.", "title": "Run Status", "x-depends-on-reports": []}, "sanctions": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks sanctions reports from UN, OFAC, EEAS and World Bank. **Depends On** details from the `run_status` report(s).", "title": "Sanctions", "x-depends-on-reports": ["run_status"]}, "vehicle_check": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Retrieves all data available for the provided `license_plate`.", "title": "Vehicle Check", "x-depends-on-reports": []}}, "title": "Reports", "type": "object"}, "bgcapi__schemas__report_settings__cl__mtt_taxi__Settings": {"description": "Report settings schema for mtt_taxi report.", "properties": {"allowed_statuses": {"default": ["VIGENTE"], "description": "Status that are allowed for a PASSED outcome.", "items": {"type": "string"}, "title": "Allowed Statuses", "type": "array"}}, "title": "CL Mtt Taxi Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__cl__vehicle_check__Settings": {"description": "Report settings schema for vehicle_check report.", "properties": {"car_years_max": {"default": 20, "description": "Maximum age of the car (in years)", "title": "Car Years Max", "type": "integer"}, "ignore_recent_not_found": {"default": true, "description": "Recently issued plates sometimes can't be queried, but they use sequential letters. This setting allows approving very recent plates even if they are not found.", "title": "Ignore Recent Not Found", "type": "boolean"}, "not_found_action": {"default": "INCOMPLETE", "description": "Action that should be taken if license plate is `not_found`.", "enum": ["FAILED", "PASSED", "INCOMPLETE"], "title": "Not Found Action", "type": "string"}, "unpaid_permit_action": {"default": "PASSED", "description": "Action that should be taken if license plate does not have a paid circulation permit", "enum": ["FAILED", "PASSED"], "title": "Unpaid Permit Action", "type": "string"}}, "title": "CL Vehicle Check Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__common__name_check__Settings": {"description": "Report settings for name_check report.", "properties": {"name_fragment_check": {"default": false, "description": "If the report should check for name fragments instead of full name check.", "title": "Name Fragment Check", "type": "boolean"}, "name_score_min": {"default": 1, "description": "Minimum score for name match for a PASSED outcome (0.00 <= n <= 1.00).", "title": "Name Score Min", "type": "number"}}, "title": "Name Check Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__common__news_search__Settings": {"description": "Report settings for news_search report.", "properties": {"info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}}, "title": "Settings", "type": "object"}, "bgcapi__schemas__report_settings__common__sanctions__Settings": {"description": "Report settings for sanctions report.", "properties": {"name_score_min": {"default": 0.9, "description": "Minimum score for name match for a PASSED outcome (0.00 <= n <= 1.00).", "title": "Name Score Min", "type": "number"}, "show_ignored_records": {"default": false, "description": "Determine if ignored records are shown in the report details.", "title": "Show Ignored Records", "type": "boolean"}}, "title": "Sanctions Report Settings", "type": "object"}}, "description": "Chile Person Schema.", "properties": {"certificate_id": {"description": "Certificate code used for validation of manually issued justice records certificates. **Required** for `justice_certificate`", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": ["justice_certificate"]}, "certificate_verification": {"description": "Certificate verification code. **Required** for `justice_certificate`", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": ["justice_certificate"]}, "city_locode": {"description": "2 letter country code and 3 letter location code for the city a person is located in. See the LOCODE reference.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "dob": {"description": "ISO 8601 representation of the date the person was born.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "document_id": {"description": "Document ID Number for Chile. *Rol Unico Nacional* - RUN. **Required** for `run_status`, `justice_certificate`, `license_status`, `criminal`, `sanctions` **Optional** for `name_check`, `reference_check`", "type": "string", "x-optional-for-reports": ["name_check", "reference_check"], "x-required-by-reports": ["run_status", "justice_certificate", "license_status", "criminal", "sanctions"]}, "document_id_alt": {"description": "Alternate Document ID Number.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "document_id_type": {"anyOf": [{"enum": ["foreigner_card", "national_id"], "type": "string"}, {"type": "string"}], "description": "Document ID type.", "x-optional-for-reports": [], "x-required-by-reports": []}, "drivers_license_id": {"description": "Driver's license ID number.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "forenames": {"description": "Forenames of the person to be checked.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "full_name": {"description": "Full Name of the person to be checked. **Optional** for `criminal`, `sanctions`, `name_check`, `news_search`, `reference_check`", "type": "string", "x-optional-for-reports": ["criminal", "sanctions", "name_check", "news_search", "reference_check"], "x-required-by-reports": []}, "license_plate": {"description": "License plate. **Required** for `mtt_taxi`, `vehicle_check`", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": ["mtt_taxi", "vehicle_check"]}, "phone": {"description": "Phone of the person to be checked.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "pipeline": {"allOf": [{"$ref": "#/components/schemas/PersonPipeline"}], "description": "Automatically enables reports and sets report_settings. It replaces `reports` and `report_settings` fields.", "x-optional-for-reports": [], "x-required-by-reports": []}, "report_settings": {"allOf": [{"$ref": "#/components/schemas/create_cl_definitions-ReportSettings"}], "description": "Custom report_settings setup by report manually.", "x-optional-for-reports": [], "x-required-by-reports": []}, "reports": {"allOf": [{"$ref": "#/components/schemas/create_cl_definitions-Reports"}], "description": "Custom report activation by enabling/disabling reports manually.", "x-optional-for-reports": [], "x-required-by-reports": []}, "surname": {"description": "Surname of the person to be checked.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "webhook_details": {"description": "If true, the webhook will include the report details in the response.", "type": "boolean", "x-optional-for-reports": [], "x-required-by-reports": []}, "webhook_headers": {"additionalProperties": {"type": "string"}, "description": "Webhook headers to send in the request to the webhook URL.", "type": "object", "x-optional-for-reports": [], "x-required-by-reports": []}, "webhook_url": {"description": "Webhook URL to receive notifications when this person has a folder finished.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}}, "required": [], "title": "Chile Person Schema", "type": "object"}, "bgcapi__schemas__report_settings__co__cedula_details__DocumentIdTypes": {"description": "Document id types.", "enum": ["national_id", "foreigner_card", "identity_card_for_minors", "special_permit", "ppt"], "title": "DocumentIdTypes", "type": "string"}, "bgcapi__schemas__report_settings__co__cedula_details__Settings": {"description": "Report settings schema for cedula_details report.", "properties": {"ignore_not_found": {"default": [], "description": "This is a list of `document_id_types` selected by client to ignore when report encounters `not_found` responses.", "items": {"$ref": "#/components/schemas/bgcapi__schemas__report_settings__co__cedula_details__DocumentIdTypes"}, "type": "array"}, "info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}}, "title": "CO Cedula Details Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__co__drunk_driving__Settings": {"description": "Report settings schema for drunk_driving report.", "properties": {"info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}}, "title": "CO Drunk Driving Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__co__fine_count__Settings": {"description": "Report settings schema for fine_count report.", "properties": {"info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}}, "title": "CO Fine Count Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__co__fine_debt__Settings": {"description": "Report settings schema for fine_debt report.", "properties": {"info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}}, "title": "CO Fine Debt Report Settings", "type": "object"}, "KeywordThreshold": {"description": "Schema to map a keyword and its threshold.", "properties": {"keyword": {"description": "Crime keyword to be mapped to the respective tolerance.", "title": "Keyword", "type": "string"}, "tolerance": {"description": "Tolerance period in years for the specified keyword.", "title": "Tolerance", "type": "integer"}}, "required": ["keyword", "tolerance"], "title": "KeywordThreshold", "type": "object"}, "bgcapi__schemas__report_settings__co__justice_record__Settings": {"description": "Report settings schema for justice_record report.", "properties": {"crime_tolerance_threshold": {"description": "The number of years defining the tolerance period for the specified `crime_keyword`. Crimes older than this period will be marked as `PASSED`. The evaluation is based on the `crime_date` field to determine the age of the crime.", "items": {"$ref": "#/components/schemas/KeywordThreshold"}, "title": "Crime Tolerance Threshold", "type": "array"}, "crime_whitelist": {"description": "List of crime names that should not fail the person. The initial field search is in the `crime` field , and if it is empty or UNKNOWN, the string will be searched in `process_type` field. It will also search in the `crime_keyword` field. The search is case-insensitive.", "items": {"type": "string"}, "title": "Crime Whitelist", "type": "array"}, "manual_review": {"default": false, "description": "Manual Review enabled/disabled for the report.", "title": "Manual Review", "type": "boolean"}}, "title": "CO Justice Record Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__co__license_status__Settings": {"description": "Report settings schema for license_status report.", "properties": {"info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}}, "title": "CO License Status Report Settings", "type": "object"}, "IgnoredByType": {"description": "Combination of conditions to ignore processes.", "properties": {"file_location": {"description": "A list of allowed file location.", "items": {"type": "string"}, "title": "File Location", "type": "array"}, "max_record_age_years": {"description": "A number which represents how old the record can be.", "title": "Max Record Age Years", "type": "integer"}, "process_subclass": {"description": "A list of allowed process subclass.", "items": {"type": "string"}, "title": "Process Subclass", "type": "array"}}, "title": "IgnoredByType", "type": "object"}, "ProcessCourtLocation": {"description": "Specific location of courts.", "properties": {"city": {"title": "City", "type": "string"}, "department": {"title": "Department", "type": "string"}}, "required": ["department", "city"], "title": "ProcessCourtLocation", "type": "object"}, "bgcapi__schemas__report_settings__co__process_search__Settings": {"description": "Report settings schema for process search report.", "properties": {"appeals_allow_list": {"description": "Choose appeal types that can be ignored.", "items": {"type": "string"}, "title": "Appeals Allow List", "type": "array"}, "courts_allow_list": {"default": ["FAMILIA", "CIVIL", "ADMINISTRATIVO", "LABORAL", "LABORALES"], "description": "Choose courts that can be ignored.", "items": {"type": "string"}, "title": "Courts Allow List", "type": "array"}, "criminal_age_majority": {"default": 14, "description": "Ignore files that were opened when the candidate was at a certain age. This includes files that were opened when the candidate had the age of juvenile criminal liability.", "title": "Criminal Age Majority", "type": "integer"}, "file_location_allow_list": {"description": "Choose file location that can be ignored.", "items": {"type": "string"}, "title": "File Location Allow List", "type": "array"}, "ignored_by_type": {"allOf": [{"$ref": "#/components/schemas/IgnoredByType"}], "description": "Combination of conditions to ignore processes.", "title": "Ignored By Type"}, "info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}, "judges_allow_list": {"default": ["CIVIL", "FAMILIA", "ADMINISTRATIVO", "LABORAL"], "description": "Choose judges that can be ignored.", "items": {"type": "string"}, "title": "Judges Allow List", "type": "array"}, "name_score_min": {"default": 1, "description": "Minimum score for name match (0.00 <= n <= 1.00).", "title": "Name Score Min", "type": "number"}, "process_class_allow_list": {"description": "Choose process class that can be ignored.", "items": {"type": "string"}, "title": "Process Class Allow List", "type": "array"}, "process_courts_priority": {"default": [{"city": "Bogota", "department": "Bogota"}, {"city": "Medellin", "department": "Antioquia"}, {"city": "Cali", "department": "Valle del Cauca"}], "description": "List of ProcessCourtLocation objects that helps to be more specific in the search, avoiding to otain too many records.", "items": {"$ref": "#/components/schemas/ProcessCourtLocation"}, "title": "Process Courts Priority", "type": "array"}, "process_part_allow_list": {"default": ["Demandante", "Apoderado"], "description": "Choose process parts that can be ignored.", "items": {"type": "string"}, "title": "Process Part Allow List", "type": "array"}, "process_subclass_allow_list": {"default": ["INASISTENCIA ALIMENTARIA"], "description": "Choose process subclass that can be ignored.", "items": {"type": "string"}, "title": "Process Subclass Allow List", "type": "array"}, "process_subject_allow_list": {"default": ["INASISTENCIA ALIMENTARIA", "ADMINISTRATIVO"], "description": "Choose process subjects that can be ignored.", "items": {"type": "string"}, "title": "Process Subject Allow List", "type": "array"}, "process_type_allow_list": {"description": "Choose process type that can be ignored.", "items": {"type": "string"}, "title": "Process Type Allow List", "type": "array"}, "show_ignored_records": {"default": false, "description": "Determine if ignored records are shown in the report details.", "title": "Show Ignored Records", "type": "boolean"}}, "title": "CO Process Search Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__co__procuradoria_record__DocumentIdTypes": {"description": "Document id types.", "enum": ["national_id", "foreigner_card", "identity_card_for_minors", "special_permit"], "title": "DocumentIdTypes", "type": "string"}, "bgcapi__schemas__report_settings__co__procuradoria_record__Settings": {"description": "Report settings schema for procuradoria_record report.", "properties": {"ignore_not_found": {"default": [], "description": "This is a list of `document_id_types` selected by client to ignore when report encounters `not_found` responses.", "items": {"$ref": "#/components/schemas/bgcapi__schemas__report_settings__co__procuradoria_record__DocumentIdTypes"}, "type": "array"}}, "title": "CO Procuradoria Record Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__co__vehicle_check__Settings": {"description": "Report settings schema for vehicle_check report.", "properties": {"accepted_policy_status": {"default": [], "description": "Policy statuses that are allowed for a PASSED outcome.", "items": {"type": "string"}, "title": "Accepted Policy Status", "type": "array"}, "accepted_vehicle_class": {"default": [], "description": "Vehicle classes that are allowed for a PASSED outcome.", "items": {"type": "string"}, "title": "Accepted Vehicle Class", "type": "array"}, "accepted_vehicle_status": {"default": [], "description": "Statuses that are allowed for a PASSED outcome.", "items": {"type": "string"}, "title": "Accepted Vehicle Status", "type": "array"}, "min_model_year": {"description": "The minimum model year that are allowed for a PASSED outcome.", "title": "Min Model Year", "type": "integer"}}, "title": "CO Vehicle Check Report Settings", "type": "object"}, "create_co_definitions-ReportSettings": {"description": "Report settings schema by report.", "properties": {"cedula_details": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__co__cedula_details__Settings"}], "description": "Report settings for cedula_details report.", "title": "Cedula Details"}, "drunk_driving": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__co__drunk_driving__Settings"}], "description": "Report settings for drunk_driving report.", "title": "Drunk Driving"}, "fine_count": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__co__fine_count__Settings"}], "description": "Report settings for fine_count report.", "title": "Fine Count"}, "fine_debt": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__co__fine_debt__Settings"}], "description": "Report settings for fine_debt report.", "title": "Fine Debt"}, "justice_record": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__co__justice_record__Settings"}], "description": "Report settings for justice_record report.", "title": "Justice Record"}, "license_status": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__co__license_status__Settings"}], "description": "Report settings for license_status report.", "title": "License Status"}, "name_check": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__name_check__Settings"}], "description": "Report settings for name_check report.", "title": "Name Check"}, "news_search": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__news_search__Settings"}], "description": "Report settings for news_search report.", "title": "News Search"}, "process_search": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__co__process_search__Settings"}], "description": "Report settings for process_search report.", "title": "Process Search"}, "procuradoria_record": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__co__procuradoria_record__Settings"}], "description": "Report settings for procuradoria_record report.", "title": "Procuradoria Record"}, "sanctions": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__sanctions__Settings"}], "description": "Sanctions Report Settings", "title": "Sanctions"}, "vehicle_check": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__co__vehicle_check__Settings"}], "description": "Report settings for vehicle_check report.", "title": "Vehicle Check"}}, "title": "ReportSettings", "type": "object"}, "create_co_definitions-Reports": {"description": "Available reports for Colombia persons.", "properties": {"cedula_details": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Document ID (*Cedula*) and retrieves details.\nNote: `dob` field is required for `ppt`/`rumv` documents.\n", "title": "Cedula Details", "x-depends-on-reports": []}, "drunk_driving": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Driver's License for Drunk Driving fines.", "title": "Drunk Driving", "x-depends-on-reports": []}, "fine_count": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Driver's registries for fines.", "title": "Fine Count", "x-depends-on-reports": []}, "fine_debt": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Driver's registries for fine debts.", "title": "Fine Debt", "x-depends-on-reports": []}, "justice_record": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Justice System for criminal records.", "title": "Justice Record", "x-depends-on-reports": []}, "license_status": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Driver's License status.", "title": "License Status", "x-depends-on-reports": []}, "name_check": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks `full_name` provided against `full_name` registered. **Depends On** details from the `cedula_details` report(s).", "title": "Name Check", "x-depends-on-reports": ["cedula_details"]}, "news_search": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks criminal and non-criminal information about a person.", "title": "News Search", "x-depends-on-reports": []}, "police_record": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Police for criminal records.", "title": "Police Record", "x-depends-on-reports": []}, "process_search": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Process Search report for criminal records.", "title": "Process Search", "x-depends-on-reports": []}, "procuradoria_record": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks *Procuradoria* for criminal records.", "title": "Procuradoria Record", "x-depends-on-reports": []}, "sanctions": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks sanctions reports from UN, OFAC, EEAS and World Bank.", "title": "Sanctions", "x-depends-on-reports": []}, "vehicle_check": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Retrieves all data available for the provided `license_plate` or `vin`.", "title": "Vehicle Check", "x-depends-on-reports": []}}, "title": "Reports", "type": "object"}, "create_co": {"definitions": {"IgnoredByType": {"description": "Combination of conditions to ignore processes.", "properties": {"file_location": {"description": "A list of allowed file location.", "items": {"type": "string"}, "title": "File Location", "type": "array"}, "max_record_age_years": {"description": "A number which represents how old the record can be.", "title": "Max Record Age Years", "type": "integer"}, "process_subclass": {"description": "A list of allowed process subclass.", "items": {"type": "string"}, "title": "Process Subclass", "type": "array"}}, "title": "IgnoredByType", "type": "object"}, "KeywordThreshold": {"description": "Schema to map a keyword and its threshold.", "properties": {"keyword": {"description": "Crime keyword to be mapped to the respective tolerance.", "title": "Keyword", "type": "string"}, "tolerance": {"description": "Tolerance period in years for the specified keyword.", "title": "Tolerance", "type": "integer"}}, "required": ["keyword", "tolerance"], "title": "KeywordThreshold", "type": "object"}, "PersonPipeline": {"description": "Person pipeline details.", "properties": {"name": {"description": "Name of created pipeline.", "title": "Name", "type": "string"}}, "required": ["name"], "title": "Person Pipeline", "type": "object"}, "ProcessCourtLocation": {"description": "Specific location of courts.", "properties": {"city": {"title": "City", "type": "string"}, "department": {"title": "Department", "type": "string"}}, "required": ["department", "city"], "title": "ProcessCourtLocation", "type": "object"}, "ReportEnable": {"description": "Enable or disable a report for a given person BGC.", "enum": ["enabled", "disabled"], "title": "ReportEnable", "type": "string"}, "ReportSettings": {"description": "Report settings schema by report.", "properties": {"cedula_details": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__co__cedula_details__Settings"}], "description": "Report settings for cedula_details report.", "title": "Cedula Details"}, "drunk_driving": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__co__drunk_driving__Settings"}], "description": "Report settings for drunk_driving report.", "title": "Drunk Driving"}, "fine_count": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__co__fine_count__Settings"}], "description": "Report settings for fine_count report.", "title": "Fine Count"}, "fine_debt": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__co__fine_debt__Settings"}], "description": "Report settings for fine_debt report.", "title": "Fine Debt"}, "justice_record": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__co__justice_record__Settings"}], "description": "Report settings for justice_record report.", "title": "Justice Record"}, "license_status": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__co__license_status__Settings"}], "description": "Report settings for license_status report.", "title": "License Status"}, "name_check": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__name_check__Settings"}], "description": "Report settings for name_check report.", "title": "Name Check"}, "news_search": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__news_search__Settings"}], "description": "Report settings for news_search report.", "title": "News Search"}, "process_search": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__co__process_search__Settings"}], "description": "Report settings for process_search report.", "title": "Process Search"}, "procuradoria_record": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__co__procuradoria_record__Settings"}], "description": "Report settings for procuradoria_record report.", "title": "Procuradoria Record"}, "sanctions": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__sanctions__Settings"}], "description": "Sanctions Report Settings", "title": "Sanctions"}, "vehicle_check": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__co__vehicle_check__Settings"}], "description": "Report settings for vehicle_check report.", "title": "Vehicle Check"}}, "title": "ReportSettings", "type": "object"}, "Reports": {"description": "Available reports for Colombia persons.", "properties": {"cedula_details": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Document ID (*Cedula*) and retrieves details.\nNote: `dob` field is required for `ppt`/`rumv` documents.\n", "title": "Cedula Details", "x-depends-on-reports": []}, "drunk_driving": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Driver's License for Drunk Driving fines.", "title": "Drunk Driving", "x-depends-on-reports": []}, "fine_count": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Driver's registries for fines.", "title": "Fine Count", "x-depends-on-reports": []}, "fine_debt": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Driver's registries for fine debts.", "title": "Fine Debt", "x-depends-on-reports": []}, "justice_record": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Justice System for criminal records.", "title": "Justice Record", "x-depends-on-reports": []}, "license_status": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Driver's License status.", "title": "License Status", "x-depends-on-reports": []}, "name_check": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks `full_name` provided against `full_name` registered. **Depends On** details from the `cedula_details` report(s).", "title": "Name Check", "x-depends-on-reports": ["cedula_details"]}, "news_search": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks criminal and non-criminal information about a person.", "title": "News Search", "x-depends-on-reports": []}, "police_record": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Police for criminal records.", "title": "Police Record", "x-depends-on-reports": []}, "process_search": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Process Search report for criminal records.", "title": "Process Search", "x-depends-on-reports": []}, "procuradoria_record": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks *Procuradoria* for criminal records.", "title": "Procuradoria Record", "x-depends-on-reports": []}, "sanctions": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks sanctions reports from UN, OFAC, EEAS and World Bank.", "title": "Sanctions", "x-depends-on-reports": []}, "vehicle_check": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Retrieves all data available for the provided `license_plate` or `vin`.", "title": "Vehicle Check", "x-depends-on-reports": []}}, "title": "Reports", "type": "object"}, "bgcapi__schemas__report_settings__co__cedula_details__DocumentIdTypes": {"description": "Document id types.", "enum": ["national_id", "foreigner_card", "identity_card_for_minors", "special_permit", "ppt"], "title": "DocumentIdTypes", "type": "string"}, "bgcapi__schemas__report_settings__co__cedula_details__Settings": {"description": "Report settings schema for cedula_details report.", "properties": {"ignore_not_found": {"default": [], "description": "This is a list of `document_id_types` selected by client to ignore when report encounters `not_found` responses.", "items": {"$ref": "#/components/schemas/bgcapi__schemas__report_settings__co__cedula_details__DocumentIdTypes"}, "type": "array"}, "info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}}, "title": "CO Cedula Details Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__co__drunk_driving__Settings": {"description": "Report settings schema for drunk_driving report.", "properties": {"info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}}, "title": "CO Drunk Driving Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__co__fine_count__Settings": {"description": "Report settings schema for fine_count report.", "properties": {"info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}}, "title": "CO Fine Count Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__co__fine_debt__Settings": {"description": "Report settings schema for fine_debt report.", "properties": {"info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}}, "title": "CO Fine Debt Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__co__justice_record__Settings": {"description": "Report settings schema for justice_record report.", "properties": {"crime_tolerance_threshold": {"description": "The number of years defining the tolerance period for the specified `crime_keyword`. Crimes older than this period will be marked as `PASSED`. The evaluation is based on the `crime_date` field to determine the age of the crime.", "items": {"$ref": "#/components/schemas/KeywordThreshold"}, "title": "Crime Tolerance Threshold", "type": "array"}, "crime_whitelist": {"description": "List of crime names that should not fail the person. The initial field search is in the `crime` field , and if it is empty or UNKNOWN, the string will be searched in `process_type` field. It will also search in the `crime_keyword` field. The search is case-insensitive.", "items": {"type": "string"}, "title": "Crime Whitelist", "type": "array"}, "manual_review": {"default": false, "description": "Manual Review enabled/disabled for the report.", "title": "Manual Review", "type": "boolean"}}, "title": "CO Justice Record Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__co__license_status__Settings": {"description": "Report settings schema for license_status report.", "properties": {"info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}}, "title": "CO License Status Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__co__process_search__Settings": {"description": "Report settings schema for process search report.", "properties": {"appeals_allow_list": {"description": "Choose appeal types that can be ignored.", "items": {"type": "string"}, "title": "Appeals Allow List", "type": "array"}, "courts_allow_list": {"default": ["FAMILIA", "CIVIL", "ADMINISTRATIVO", "LABORAL", "LABORALES"], "description": "Choose courts that can be ignored.", "items": {"type": "string"}, "title": "Courts Allow List", "type": "array"}, "criminal_age_majority": {"default": 14, "description": "Ignore files that were opened when the candidate was at a certain age. This includes files that were opened when the candidate had the age of juvenile criminal liability.", "title": "Criminal Age Majority", "type": "integer"}, "file_location_allow_list": {"description": "Choose file location that can be ignored.", "items": {"type": "string"}, "title": "File Location Allow List", "type": "array"}, "ignored_by_type": {"allOf": [{"$ref": "#/components/schemas/IgnoredByType"}], "description": "Combination of conditions to ignore processes.", "title": "Ignored By Type"}, "info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}, "judges_allow_list": {"default": ["CIVIL", "FAMILIA", "ADMINISTRATIVO", "LABORAL"], "description": "Choose judges that can be ignored.", "items": {"type": "string"}, "title": "Judges Allow List", "type": "array"}, "name_score_min": {"default": 1, "description": "Minimum score for name match (0.00 <= n <= 1.00).", "title": "Name Score Min", "type": "number"}, "process_class_allow_list": {"description": "Choose process class that can be ignored.", "items": {"type": "string"}, "title": "Process Class Allow List", "type": "array"}, "process_courts_priority": {"default": [{"city": "Bogota", "department": "Bogota"}, {"city": "Medellin", "department": "Antioquia"}, {"city": "Cali", "department": "Valle del Cauca"}], "description": "List of ProcessCourtLocation objects that helps to be more specific in the search, avoiding to otain too many records.", "items": {"$ref": "#/components/schemas/ProcessCourtLocation"}, "title": "Process Courts Priority", "type": "array"}, "process_part_allow_list": {"default": ["Demandante", "Apoderado"], "description": "Choose process parts that can be ignored.", "items": {"type": "string"}, "title": "Process Part Allow List", "type": "array"}, "process_subclass_allow_list": {"default": ["INASISTENCIA ALIMENTARIA"], "description": "Choose process subclass that can be ignored.", "items": {"type": "string"}, "title": "Process Subclass Allow List", "type": "array"}, "process_subject_allow_list": {"default": ["INASISTENCIA ALIMENTARIA", "ADMINISTRATIVO"], "description": "Choose process subjects that can be ignored.", "items": {"type": "string"}, "title": "Process Subject Allow List", "type": "array"}, "process_type_allow_list": {"description": "Choose process type that can be ignored.", "items": {"type": "string"}, "title": "Process Type Allow List", "type": "array"}, "show_ignored_records": {"default": false, "description": "Determine if ignored records are shown in the report details.", "title": "Show Ignored Records", "type": "boolean"}}, "title": "CO Process Search Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__co__procuradoria_record__DocumentIdTypes": {"description": "Document id types.", "enum": ["national_id", "foreigner_card", "identity_card_for_minors", "special_permit"], "title": "DocumentIdTypes", "type": "string"}, "bgcapi__schemas__report_settings__co__procuradoria_record__Settings": {"description": "Report settings schema for procuradoria_record report.", "properties": {"ignore_not_found": {"default": [], "description": "This is a list of `document_id_types` selected by client to ignore when report encounters `not_found` responses.", "items": {"$ref": "#/components/schemas/bgcapi__schemas__report_settings__co__procuradoria_record__DocumentIdTypes"}, "type": "array"}}, "title": "CO Procuradoria Record Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__co__vehicle_check__Settings": {"description": "Report settings schema for vehicle_check report.", "properties": {"accepted_policy_status": {"default": [], "description": "Policy statuses that are allowed for a PASSED outcome.", "items": {"type": "string"}, "title": "Accepted Policy Status", "type": "array"}, "accepted_vehicle_class": {"default": [], "description": "Vehicle classes that are allowed for a PASSED outcome.", "items": {"type": "string"}, "title": "Accepted Vehicle Class", "type": "array"}, "accepted_vehicle_status": {"default": [], "description": "Statuses that are allowed for a PASSED outcome.", "items": {"type": "string"}, "title": "Accepted Vehicle Status", "type": "array"}, "min_model_year": {"description": "The minimum model year that are allowed for a PASSED outcome.", "title": "Min Model Year", "type": "integer"}}, "title": "CO Vehicle Check Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__common__name_check__Settings": {"description": "Report settings for name_check report.", "properties": {"name_fragment_check": {"default": false, "description": "If the report should check for name fragments instead of full name check.", "title": "Name Fragment Check", "type": "boolean"}, "name_score_min": {"default": 1, "description": "Minimum score for name match for a PASSED outcome (0.00 <= n <= 1.00).", "title": "Name Score Min", "type": "number"}}, "title": "Name Check Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__common__news_search__Settings": {"description": "Report settings for news_search report.", "properties": {"info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}}, "title": "Settings", "type": "object"}, "bgcapi__schemas__report_settings__common__sanctions__Settings": {"description": "Report settings for sanctions report.", "properties": {"name_score_min": {"default": 0.9, "description": "Minimum score for name match for a PASSED outcome (0.00 <= n <= 1.00).", "title": "Name Score Min", "type": "number"}, "show_ignored_records": {"default": false, "description": "Determine if ignored records are shown in the report details.", "title": "Show Ignored Records", "type": "boolean"}}, "title": "Sanctions Report Settings", "type": "object"}}, "description": "Colombia Person Schema.", "properties": {"city_locode": {"description": "2 letter country code and 3 letter location code for the city a person is located in. See the LOCODE reference.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "dob": {"description": "ISO 8601 representation of the date the person was born. **Optional** for `cedula_details`, `process_search`", "type": "string", "x-optional-for-reports": ["cedula_details", "process_search"], "x-required-by-reports": []}, "document_id": {"description": "Document ID Number. **Required** for `license_status`, `drunk_driving`, `fine_debt`, `fine_count`, `justice_record`, `police_record`, `cedula_details`, `procuradoria_record` **Optional** for `vehicle_check`, `name_check`, `reference_check`", "type": "string", "x-optional-for-reports": ["vehicle_check", "name_check", "reference_check"], "x-required-by-reports": ["license_status", "drunk_driving", "fine_debt", "fine_count", "justice_record", "police_record", "cedula_details", "procuradoria_record"]}, "document_id_alt": {"description": "Alternate Document ID Number.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "document_id_type": {"anyOf": [{"enum": ["diplomatic_card", "foreigner_card", "identity_card_for_minors", "national_id", "passport", "ppt", "special_permit", "civil_registry"], "type": "string"}, {"type": "string"}], "description": "Document ID type. **Required** for `license_status`, `drunk_driving`, `fine_debt`, `fine_count`, `police_record`, `cedula_details`, `procuradoria_record` **Optional** for `vehicle_check`", "x-optional-for-reports": ["vehicle_check"], "x-required-by-reports": ["license_status", "drunk_driving", "fine_debt", "fine_count", "police_record", "cedula_details", "procuradoria_record"]}, "drivers_license_id": {"description": "Driver's license ID number.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "forenames": {"description": "Forenames of the person to be checked.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "full_name": {"description": "Full Name of the person to be checked. **Required** for `sanctions` **Optional** for `sanctions`, `process_search`, `name_check`, `news_search`, `reference_check`", "type": "string", "x-optional-for-reports": ["sanctions", "process_search", "name_check", "news_search", "reference_check"], "x-required-by-reports": ["sanctions"]}, "license_plate": {"description": "License plate. **Optional** for `vehicle_check`", "type": "string", "x-optional-for-reports": ["vehicle_check"], "x-required-by-reports": []}, "phone": {"description": "Phone of the person to be checked.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "pipeline": {"allOf": [{"$ref": "#/components/schemas/PersonPipeline"}], "description": "Automatically enables reports and sets report_settings. It replaces `reports` and `report_settings` fields.", "x-optional-for-reports": [], "x-required-by-reports": []}, "report_settings": {"allOf": [{"$ref": "#/components/schemas/create_co_definitions-ReportSettings"}], "description": "Custom report_settings setup by report manually.", "x-optional-for-reports": [], "x-required-by-reports": []}, "reports": {"allOf": [{"$ref": "#/components/schemas/create_co_definitions-Reports"}], "description": "Custom report activation by enabling/disabling reports manually.", "x-optional-for-reports": [], "x-required-by-reports": []}, "surname": {"description": "Surname of the person to be checked.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "vehicle_owner_cedula": {"description": "Cedula of vehicle owner. **Optional** for `vehicle_check`", "type": "string", "x-optional-for-reports": ["vehicle_check"], "x-required-by-reports": []}, "vin": {"description": "VIN Vehicle Identification number. **Optional** for `vehicle_check`", "type": "string", "x-optional-for-reports": ["vehicle_check"], "x-required-by-reports": []}, "webhook_details": {"description": "If true, the webhook will include the report details in the response.", "type": "boolean", "x-optional-for-reports": [], "x-required-by-reports": []}, "webhook_headers": {"additionalProperties": {"type": "string"}, "description": "Webhook headers to send in the request to the webhook URL.", "type": "object", "x-optional-for-reports": [], "x-required-by-reports": []}, "webhook_url": {"description": "Webhook URL to receive notifications when this person has a folder finished.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}}, "required": ["city_locode"], "title": "Colombia Person Schema", "type": "object"}, "bgcapi__schemas__report_settings__cr__archivo_judicial__Settings": {"description": "Report settings schema for Archivo Judicial report.", "properties": {"criminal_age_majority": {"default": 18, "description": "Ignore files that were opened when the candidate was at a certain age. This includes files that were opened when the candidate had the age of juvenile criminal liability.", "title": "Criminal Age Majority", "type": "integer"}, "info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}, "max_record_age_years": {"description": "Records older than this number of years will be ignored.", "title": "Max Record Age Years", "type": "integer"}, "office_type_allow_list": {"description": "Choose offices that can be ignored.", "items": {"type": "string"}, "title": "Office Type Allow List", "type": "array"}, "process_type_allow_list": {"description": "Choose process types that can be ignored.", "items": {"type": "string"}, "title": "Process Type Allow List", "type": "array"}, "show_ignored_records": {"default": false, "description": "Determine if ignored records are shown in the report details.", "title": "Show Ignored Records", "type": "boolean"}}, "title": "CR Archivo Judicial Report Settings", "type": "object"}, "create_cr_definitions-ReportSettings": {"description": "Report settings schema by report.", "properties": {"archivo_judicial": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__cr__archivo_judicial__Settings"}], "description": "Report settings for archivo_judicial report.", "title": "Archivo Judicial"}, "name_check": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__name_check__Settings"}], "description": "Report settings for name_check report.", "title": "Name Check"}, "news_search": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__news_search__Settings"}], "description": "Report settings for news search report.", "title": "News Search"}, "sanctions": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__sanctions__Settings"}], "description": "Sanctions Report Settings", "title": "Sanctions"}}, "title": "ReportSettings", "type": "object"}, "create_cr_definitions-Reports": {"description": "Available reports for Costa Rica persons.", "properties": {"archivo_judicial": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Judicial Archive report for criminal records. **Depends On** details from the `cedula_status` report(s).", "title": "Archivo Judicial", "x-depends-on-reports": ["cedula_status"]}, "boletin_judicial": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Justice System journals for criminal records.", "title": "Boletin Judicial", "x-depends-on-reports": []}, "cedula_status": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks `document_id`.", "title": "Cedula Status", "x-depends-on-reports": []}, "dob_check": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks `dob` provided against `dob` registered. Available only for *Cedula de Ciudadania* documents issued by [*TSE*](https://www.tse.go.cr/). **Depends On** details from the `cedula_status` report(s).", "title": "Date of birth Check", "x-depends-on-reports": ["cedula_status"]}, "name_check": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks `full_name` provided against `full_name` registered. **Depends On** details from the `cedula_status` report(s).", "title": "Name Check", "x-depends-on-reports": ["cedula_status"]}, "news_search": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks criminal and non-criminal information about a person.", "title": "News Search", "x-depends-on-reports": []}, "sanctions": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks sanctions reports from UN, OFAC, EEAS and World Bank. **Depends On** details from the `cedula_status` report(s).", "title": "Sanctions", "x-depends-on-reports": ["cedula_status"]}}, "title": "Reports", "type": "object"}, "create_cr": {"definitions": {"PersonPipeline": {"description": "Person pipeline details.", "properties": {"name": {"description": "Name of created pipeline.", "title": "Name", "type": "string"}}, "required": ["name"], "title": "Person Pipeline", "type": "object"}, "ReportEnable": {"description": "Enable or disable a report for a given person BGC.", "enum": ["enabled", "disabled"], "title": "ReportEnable", "type": "string"}, "ReportSettings": {"description": "Report settings schema by report.", "properties": {"archivo_judicial": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__cr__archivo_judicial__Settings"}], "description": "Report settings for archivo_judicial report.", "title": "Archivo Judicial"}, "name_check": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__name_check__Settings"}], "description": "Report settings for name_check report.", "title": "Name Check"}, "news_search": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__news_search__Settings"}], "description": "Report settings for news search report.", "title": "News Search"}, "sanctions": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__sanctions__Settings"}], "description": "Sanctions Report Settings", "title": "Sanctions"}}, "title": "ReportSettings", "type": "object"}, "Reports": {"description": "Available reports for Costa Rica persons.", "properties": {"archivo_judicial": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Judicial Archive report for criminal records. **Depends On** details from the `cedula_status` report(s).", "title": "Archivo Judicial", "x-depends-on-reports": ["cedula_status"]}, "boletin_judicial": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Justice System journals for criminal records.", "title": "Boletin Judicial", "x-depends-on-reports": []}, "cedula_status": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks `document_id`.", "title": "Cedula Status", "x-depends-on-reports": []}, "dob_check": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks `dob` provided against `dob` registered. Available only for *Cedula de Ciudadania* documents issued by [*TSE*](https://www.tse.go.cr/). **Depends On** details from the `cedula_status` report(s).", "title": "Date of birth Check", "x-depends-on-reports": ["cedula_status"]}, "name_check": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks `full_name` provided against `full_name` registered. **Depends On** details from the `cedula_status` report(s).", "title": "Name Check", "x-depends-on-reports": ["cedula_status"]}, "news_search": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks criminal and non-criminal information about a person.", "title": "News Search", "x-depends-on-reports": []}, "sanctions": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks sanctions reports from UN, OFAC, EEAS and World Bank. **Depends On** details from the `cedula_status` report(s).", "title": "Sanctions", "x-depends-on-reports": ["cedula_status"]}}, "title": "Reports", "type": "object"}, "bgcapi__schemas__report_settings__common__name_check__Settings": {"description": "Report settings for name_check report.", "properties": {"name_fragment_check": {"default": false, "description": "If the report should check for name fragments instead of full name check.", "title": "Name Fragment Check", "type": "boolean"}, "name_score_min": {"default": 1, "description": "Minimum score for name match for a PASSED outcome (0.00 <= n <= 1.00).", "title": "Name Score Min", "type": "number"}}, "title": "Name Check Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__common__news_search__Settings": {"description": "Report settings for news_search report.", "properties": {"info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}}, "title": "Settings", "type": "object"}, "bgcapi__schemas__report_settings__common__sanctions__Settings": {"description": "Report settings for sanctions report.", "properties": {"name_score_min": {"default": 0.9, "description": "Minimum score for name match for a PASSED outcome (0.00 <= n <= 1.00).", "title": "Name Score Min", "type": "number"}, "show_ignored_records": {"default": false, "description": "Determine if ignored records are shown in the report details.", "title": "Show Ignored Records", "type": "boolean"}}, "title": "Sanctions Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__cr__archivo_judicial__Settings": {"description": "Report settings schema for Archivo Judicial report.", "properties": {"criminal_age_majority": {"default": 18, "description": "Ignore files that were opened when the candidate was at a certain age. This includes files that were opened when the candidate had the age of juvenile criminal liability.", "title": "Criminal Age Majority", "type": "integer"}, "info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}, "max_record_age_years": {"description": "Records older than this number of years will be ignored.", "title": "Max Record Age Years", "type": "integer"}, "office_type_allow_list": {"description": "Choose offices that can be ignored.", "items": {"type": "string"}, "title": "Office Type Allow List", "type": "array"}, "process_type_allow_list": {"description": "Choose process types that can be ignored.", "items": {"type": "string"}, "title": "Process Type Allow List", "type": "array"}, "show_ignored_records": {"default": false, "description": "Determine if ignored records are shown in the report details.", "title": "Show Ignored Records", "type": "boolean"}}, "title": "CR Archivo Judicial Report Settings", "type": "object"}}, "description": "Costa Rica Person Schema.", "properties": {"city_locode": {"description": "2 letter country code and 3 letter location code for the city a person is located in. See the LOCODE reference.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "dob": {"description": "ISO 8601 representation of the date the person was born. **Required** for `dob_check`", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": ["dob_check"]}, "document_id": {"description": "Document ID Number for Costa Rica. **Required** for `cedula_status`, `boletin_judicial`, `archivo_judicial`, `dob_check`, `sanctions` **Optional** for `name_check`, `reference_check`", "type": "string", "x-optional-for-reports": ["name_check", "reference_check"], "x-required-by-reports": ["cedula_status", "boletin_judicial", "archivo_judicial", "dob_check", "sanctions"]}, "document_id_alt": {"description": "Alternate Document ID Number.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "document_id_type": {"anyOf": [{"enum": ["foreigner_card", "national_id"], "type": "string"}, {"type": "string"}], "description": "Document ID type. **Required** for `cedula_status`", "x-optional-for-reports": [], "x-required-by-reports": ["cedula_status"]}, "drivers_license_id": {"description": "Driver's license ID number.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "forenames": {"description": "Forenames of the person to be checked. **Optional** for `archivo_judicial`", "type": "string", "x-optional-for-reports": ["archivo_judicial"], "x-required-by-reports": []}, "full_name": {"description": "Full Name of the person to be checked. **Optional** for `name_check`, `sanctions`, `news_search`, `reference_check`", "type": "string", "x-optional-for-reports": ["name_check", "sanctions", "news_search", "reference_check"], "x-required-by-reports": []}, "phone": {"description": "Phone of the person to be checked.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "pipeline": {"allOf": [{"$ref": "#/components/schemas/PersonPipeline"}], "description": "Automatically enables reports and sets report_settings. It replaces `reports` and `report_settings` fields.", "x-optional-for-reports": [], "x-required-by-reports": []}, "report_settings": {"allOf": [{"$ref": "#/components/schemas/create_cr_definitions-ReportSettings"}], "description": "Custom report_settings by report.", "x-optional-for-reports": [], "x-required-by-reports": []}, "reports": {"allOf": [{"$ref": "#/components/schemas/create_cr_definitions-Reports"}], "description": "Custom report activation by enabling/disabling reports manually.", "x-optional-for-reports": [], "x-required-by-reports": []}, "surname": {"description": "Surname of the person to be checked. **Optional** for `archivo_judicial`", "type": "string", "x-optional-for-reports": ["archivo_judicial"], "x-required-by-reports": []}, "webhook_details": {"description": "If true, the webhook will include the report details in the response.", "type": "boolean", "x-optional-for-reports": [], "x-required-by-reports": []}, "webhook_headers": {"additionalProperties": {"type": "string"}, "description": "Webhook headers to send in the request to the webhook URL.", "type": "object", "x-optional-for-reports": [], "x-required-by-reports": []}, "webhook_url": {"description": "Webhook URL to receive notifications when this person has a folder finished.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}}, "required": ["city_locode"], "title": "Costa Rica Person Schema", "type": "object"}, "bgcapi__schemas__report_settings__ec__driving_record__Settings": {"description": "Report settings schema for driving_record report.", "properties": {"failed_articles_list": {"default": ["375", "376", "377", "384", "385"], "description": "List of infraction articles to result in FAILED outcome as described in the [Driving Record Outcome Workflow](https://docs.emptor.io/docs/ecuador#driving-record-outcome-workflow).", "items": {"type": "string"}, "title": "Failed Articles List", "type": "array"}, "failed_statuses": {"default": ["PENDING", "CONTESTED", "PAID", "SETTLEMENT"], "description": "List of [fine statuses](https://docs.emptor.io/docs/ecuador#fine-statuses) to be considered for a FAILED outcome.", "items": {"type": "string"}, "title": "Failed Statuses", "type": "array"}, "minimum_points": {"default": 18, "description": "Minimum score for name match for a PASSED outcome (default set to `18`).", "title": "Minimum Points", "type": "integer"}}, "title": "EC Driving Record Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__ec__justice_record__Settings": {"description": "Report settings schema for justice_record report.", "properties": {"articles_whitelist": {"default": ["ALIMENTOS"], "description": "List of strings (`str`) to be used to whitelist articles.", "items": {"type": "string"}, "title": "Articles Whitelist", "type": "array"}, "courts_whitelist": {"default": ["UNIDAD JUDICIAL CIVIL", "UNIDAD JUDICIAL DE TRABAJO", "FAMILIA"], "description": "List of strings (`str`) to be used to whitelist courts (if `str` in `court name`).", "items": {"type": "string"}, "title": "Courts Whitelist", "type": "array"}, "roles_whitelist": {"default": ["OFENDIDO"], "description": "List of strings (`str`) to be used to whitelist roles (if `str` in `parts`).", "items": {"type": "string"}, "title": "Roles Whitelist", "type": "array"}}, "title": "EC Justice Record Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__ec__license_status__Settings": {"description": "Report settings schema for license_status report.", "properties": {"required_license_types": {"default": ["B", "C", "D"], "description": "A list of the [license types](https://docs.emptor.io/docs/ecuador#drivers-license-types) that can generate a PASSED result. It is required *at least one of* the license types in the list.", "items": {"type": "string"}, "title": "Required License Types", "type": "array"}, "validity_check": {"default": true, "description": "Indicates if the validity of the driver's license should be checked by the report (*i.e.* check if the license is expire or not).", "title": "Validity Check", "type": "boolean"}}, "title": "EC License Status Report Settings", "type": "object"}, "create_ec_definitions-ReportSettings": {"description": "Report settings schema by report.", "properties": {"driving_record": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__ec__driving_record__Settings"}], "description": "Report settings for driving_record report.", "title": "Driving Record"}, "justice_record": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__ec__justice_record__Settings"}], "description": "Report settings for justice_record report.", "title": "Justice Record"}, "license_status": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__ec__license_status__Settings"}], "description": "Report settings for license_status report.", "title": "License Status"}, "name_check": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__name_check__Settings"}], "description": "Report settings for name_check report.", "title": "Name Check"}, "news_search": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__news_search__Settings"}], "description": "Report settings for news search report.", "title": "News Search"}, "sanctions": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__sanctions__Settings"}], "description": "Sanctions Report Settings", "title": "Sanctions"}}, "title": "ReportSettings", "type": "object"}, "create_ec_definitions-Reports": {"description": "Available reports for Ecuador persons.", "properties": {"cedula_details": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Document ID (*Cedula/NUI*) and retrieves details.", "title": "Cedula Details", "x-depends-on-reports": []}, "driving_record": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Driver's License records.", "title": "Driving Record", "x-depends-on-reports": []}, "justice_record": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks for records at the Justice System.", "title": "Justice Record", "x-depends-on-reports": []}, "license_status": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Driver's License status.", "title": "License Status", "x-depends-on-reports": []}, "name_check": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks `full_name` provided against `full_name` registered. **Depends On** details from the `cedula_details` report(s).", "title": "Name Check", "x-depends-on-reports": ["cedula_details"]}, "news_search": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks criminal and non-criminal information about a person.", "title": "News Search", "x-depends-on-reports": []}, "sanctions": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks sanctions reports from UN, OFAC, EEAS and World Bank. **Depends On** details from the `cedula_details` report(s).", "title": "Sanctions", "x-depends-on-reports": ["cedula_details"]}}, "title": "Reports", "type": "object"}, "create_ec": {"definitions": {"PersonPipeline": {"description": "Person pipeline details.", "properties": {"name": {"description": "Name of created pipeline.", "title": "Name", "type": "string"}}, "required": ["name"], "title": "Person Pipeline", "type": "object"}, "ReportEnable": {"description": "Enable or disable a report for a given person BGC.", "enum": ["enabled", "disabled"], "title": "ReportEnable", "type": "string"}, "ReportSettings": {"description": "Report settings schema by report.", "properties": {"driving_record": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__ec__driving_record__Settings"}], "description": "Report settings for driving_record report.", "title": "Driving Record"}, "justice_record": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__ec__justice_record__Settings"}], "description": "Report settings for justice_record report.", "title": "Justice Record"}, "license_status": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__ec__license_status__Settings"}], "description": "Report settings for license_status report.", "title": "License Status"}, "name_check": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__name_check__Settings"}], "description": "Report settings for name_check report.", "title": "Name Check"}, "news_search": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__news_search__Settings"}], "description": "Report settings for news search report.", "title": "News Search"}, "sanctions": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__sanctions__Settings"}], "description": "Sanctions Report Settings", "title": "Sanctions"}}, "title": "ReportSettings", "type": "object"}, "Reports": {"description": "Available reports for Ecuador persons.", "properties": {"cedula_details": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Document ID (*Cedula/NUI*) and retrieves details.", "title": "Cedula Details", "x-depends-on-reports": []}, "driving_record": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Driver's License records.", "title": "Driving Record", "x-depends-on-reports": []}, "justice_record": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks for records at the Justice System.", "title": "Justice Record", "x-depends-on-reports": []}, "license_status": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Driver's License status.", "title": "License Status", "x-depends-on-reports": []}, "name_check": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks `full_name` provided against `full_name` registered. **Depends On** details from the `cedula_details` report(s).", "title": "Name Check", "x-depends-on-reports": ["cedula_details"]}, "news_search": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks criminal and non-criminal information about a person.", "title": "News Search", "x-depends-on-reports": []}, "sanctions": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks sanctions reports from UN, OFAC, EEAS and World Bank. **Depends On** details from the `cedula_details` report(s).", "title": "Sanctions", "x-depends-on-reports": ["cedula_details"]}}, "title": "Reports", "type": "object"}, "bgcapi__schemas__report_settings__common__name_check__Settings": {"description": "Report settings for name_check report.", "properties": {"name_fragment_check": {"default": false, "description": "If the report should check for name fragments instead of full name check.", "title": "Name Fragment Check", "type": "boolean"}, "name_score_min": {"default": 1, "description": "Minimum score for name match for a PASSED outcome (0.00 <= n <= 1.00).", "title": "Name Score Min", "type": "number"}}, "title": "Name Check Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__common__news_search__Settings": {"description": "Report settings for news_search report.", "properties": {"info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}}, "title": "Settings", "type": "object"}, "bgcapi__schemas__report_settings__common__sanctions__Settings": {"description": "Report settings for sanctions report.", "properties": {"name_score_min": {"default": 0.9, "description": "Minimum score for name match for a PASSED outcome (0.00 <= n <= 1.00).", "title": "Name Score Min", "type": "number"}, "show_ignored_records": {"default": false, "description": "Determine if ignored records are shown in the report details.", "title": "Show Ignored Records", "type": "boolean"}}, "title": "Sanctions Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__ec__driving_record__Settings": {"description": "Report settings schema for driving_record report.", "properties": {"failed_articles_list": {"default": ["375", "376", "377", "384", "385"], "description": "List of infraction articles to result in FAILED outcome as described in the [Driving Record Outcome Workflow](https://docs.emptor.io/docs/ecuador#driving-record-outcome-workflow).", "items": {"type": "string"}, "title": "Failed Articles List", "type": "array"}, "failed_statuses": {"default": ["PENDING", "CONTESTED", "PAID", "SETTLEMENT"], "description": "List of [fine statuses](https://docs.emptor.io/docs/ecuador#fine-statuses) to be considered for a FAILED outcome.", "items": {"type": "string"}, "title": "Failed Statuses", "type": "array"}, "minimum_points": {"default": 18, "description": "Minimum score for name match for a PASSED outcome (default set to `18`).", "title": "Minimum Points", "type": "integer"}}, "title": "EC Driving Record Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__ec__justice_record__Settings": {"description": "Report settings schema for justice_record report.", "properties": {"articles_whitelist": {"default": ["ALIMENTOS"], "description": "List of strings (`str`) to be used to whitelist articles.", "items": {"type": "string"}, "title": "Articles Whitelist", "type": "array"}, "courts_whitelist": {"default": ["UNIDAD JUDICIAL CIVIL", "UNIDAD JUDICIAL DE TRABAJO", "FAMILIA"], "description": "List of strings (`str`) to be used to whitelist courts (if `str` in `court name`).", "items": {"type": "string"}, "title": "Courts Whitelist", "type": "array"}, "roles_whitelist": {"default": ["OFENDIDO"], "description": "List of strings (`str`) to be used to whitelist roles (if `str` in `parts`).", "items": {"type": "string"}, "title": "Roles Whitelist", "type": "array"}}, "title": "EC Justice Record Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__ec__license_status__Settings": {"description": "Report settings schema for license_status report.", "properties": {"required_license_types": {"default": ["B", "C", "D"], "description": "A list of the [license types](https://docs.emptor.io/docs/ecuador#drivers-license-types) that can generate a PASSED result. It is required *at least one of* the license types in the list.", "items": {"type": "string"}, "title": "Required License Types", "type": "array"}, "validity_check": {"default": true, "description": "Indicates if the validity of the driver's license should be checked by the report (*i.e.* check if the license is expire or not).", "title": "Validity Check", "type": "boolean"}}, "title": "EC License Status Report Settings", "type": "object"}}, "description": "Ecuador Person Schema.", "properties": {"city_locode": {"description": "2 letter country code and 3 letter location code for the city a person is located in. See the LOCODE reference.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "dob": {"description": "ISO 8601 representation of the date the person was born.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "document_id": {"description": "Document ID Number for Ecuador. *Numero de Cedula / NUI*. **Required** for `license_status`, `driving_record`, `justice_record`, `cedula_details`, `sanctions` **Optional** for `name_check`, `reference_check`", "type": "string", "x-optional-for-reports": ["name_check", "reference_check"], "x-required-by-reports": ["license_status", "driving_record", "justice_record", "cedula_details", "sanctions"]}, "document_id_alt": {"description": "Alternate Document ID Number.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "document_id_type": {"anyOf": [{"enum": ["foreigner_card", "national_id"], "type": "string"}, {"type": "string"}], "description": "Document ID type.", "x-optional-for-reports": [], "x-required-by-reports": []}, "drivers_license_id": {"description": "Driver's license ID number.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "forenames": {"description": "Forenames of the person to be checked.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "full_name": {"description": "Full Name of the person to be checked. **Optional** for `sanctions`, `name_check`, `news_search`, `reference_check`", "type": "string", "x-optional-for-reports": ["sanctions", "name_check", "news_search", "reference_check"], "x-required-by-reports": []}, "phone": {"description": "Phone of the person to be checked.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "pipeline": {"allOf": [{"$ref": "#/components/schemas/PersonPipeline"}], "description": "Automatically enables reports and sets report_settings. It replaces `reports` and `report_settings` fields.", "x-optional-for-reports": [], "x-required-by-reports": []}, "report_settings": {"allOf": [{"$ref": "#/components/schemas/create_ec_definitions-ReportSettings"}], "description": "Custom report_settings setup by report manually.", "x-optional-for-reports": [], "x-required-by-reports": []}, "reports": {"allOf": [{"$ref": "#/components/schemas/create_ec_definitions-Reports"}], "description": "Custom report activation by enabling/disabling reports manually.", "x-optional-for-reports": [], "x-required-by-reports": []}, "surname": {"description": "Surname of the person to be checked.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "webhook_details": {"description": "If true, the webhook will include the report details in the response.", "type": "boolean", "x-optional-for-reports": [], "x-required-by-reports": []}, "webhook_headers": {"additionalProperties": {"type": "string"}, "description": "Webhook headers to send in the request to the webhook URL.", "type": "object", "x-optional-for-reports": [], "x-required-by-reports": []}, "webhook_url": {"description": "Webhook URL to receive notifications when this person has a folder finished.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}}, "required": [], "title": "Ecuador Person Schema", "type": "object"}, "bgcapi__schemas__report_settings__mx__federal_match__Settings": {"description": "Report settings for MX vehicle_check report.", "properties": {"criminal_age_majority": {"default": 13, "description": "Records older than age of this person, will be ignored.", "title": "Criminal Age Majority", "type": "integer"}, "max_record_age_years": {"default": 100, "description": "Records older than this number of years will be ignored.", "title": "Max Record Age Years", "type": "integer"}}, "title": "MX Federal Match Check Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__mx__federal_records__Settings": {"description": "Report settings for MX federal_records report.", "properties": {"age_majority": {"default": 18, "description": "Ignore files that were opened when the candidate was at a certain age. This includes files that were opened when the candidate had that age.", "title": "Age Majority", "type": "integer"}, "autoridad_whitelist": {"description": "List of string which is checked against the field `autoridad` of the records. If it is a partial match, the record is dismissed.", "items": {"type": "string"}, "title": "Autoridad Whitelist", "type": "array"}, "court_whitelist": {"description": "List of allowed strings which is checked against the field `court_id` of the records found.", "items": {"type": "string"}, "title": "Court Whitelist", "type": "array"}, "info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}, "manual_review": {"default": false, "description": "Determines if the folder should go to manual review when there are non-dismissed records found.", "title": "Manual Review", "type": "boolean"}, "max_record_age_years": {"default": 10, "description": "Records older than this number of years will be ignored.", "title": "Max Record Age Years", "type": "integer"}, "name_score_min": {"default": 0.9, "description": "Minimum score for name match (0.00 <= n <= 1.00).", "title": "Name Score Min", "type": "number"}, "search_publication_type": {"description": "Determines which type of records will be returned.", "items": {"enum": ["amparo", "penal", "civil_administrativa"], "type": "string"}, "title": "Search Publication Type", "type": "array"}, "tipo_whitelist": {"description": "List of string which is checked against the field `tipo` of the records. If it is a partial match, the record is dismissed.", "items": {"type": "string"}, "title": "Tipo Whitelist", "type": "array"}}, "title": "MX Federal Records Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__mx__fiscal_info__Settings": {"description": "Report settings schema for fiscal_info report.", "properties": {"info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}}, "title": "MX Fiscal Info Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__mx__labor_history__Settings": {"description": "Report settings schema for labor_history report.", "properties": {"info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}}, "title": "MX Labor History Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__mx__license_status__Settings": {"description": "Report settings for MX license_status report.", "properties": {"not_found_action": {"default": "INCOMPLETE", "description": "Action that should be taken if status is `not_found`.", "enum": ["FAILED", "PASSED", "INCOMPLETE", "INFO"], "title": "Not Found Action", "type": "string"}}, "title": "MX License Status Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__mx__nss__Settings": {"description": "Report settings schema for nss report.", "properties": {"info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}}, "title": "MX NSS Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__mx__professional_license__Settings": {"description": "Report settings schema for professional_license report.", "properties": {"age_majority": {"default": 18, "description": "Ignore licenses that were issued when the candidate was younger than a certain age. This will only be applied if `name_search` is enabled.", "title": "Age Majority", "type": "integer"}, "info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}, "name_score_min": {"default": 0.9, "description": "Minimum score for name match (0.00 <= n <= 1.00). This will only be applied if `name_search` is enabled.", "title": "Name Score Min", "type": "number"}, "name_search": {"default": false, "description": "Search by person names if search by CURP doesn't return results. A manual review will not be required if this is enabled.", "title": "Name Search", "type": "boolean"}}, "title": "MX Professional License Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__mx__rfc__Settings": {"description": "Report settings schema for rfc report.", "properties": {"info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}, "not_found_action": {"default": "INCOMPLETE", "description": "Action that should be taken rfc is `not_found`.", "enum": ["FAILED", "PASSED", "INCOMPLETE"], "title": "Not Found Action", "type": "string"}}, "title": "MX Rfc Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__mx__state_match__Settings": {"description": "Report settings for MX state_match report.", "properties": {"filter_results": {"default": "criminal", "description": "Filter results by criminal or non-criminal records.", "enum": ["criminal", "non-criminal", "all"], "title": "Filter Results", "type": "string"}, "show_all_items": {"default": false, "description": "Show all matching records.", "title": "Show All Items", "type": "boolean"}}, "title": "MX State Match Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__mx__vehicle_check__Settings": {"description": "Report settings for MX vehicle_check report.", "properties": {"allowed_statuses": {"default": ["Recuperado"], "description": "Filter out statuses from `robbery_reports`.", "items": {"type": "string"}, "title": "Allowed Statuses", "type": "array"}, "not_found_action": {"default": "INCOMPLETE", "description": "Action that should be taken if status is `not_found`.", "enum": ["FAILED", "PASSED", "INCOMPLETE", "INFO"], "title": "Not Found Action", "type": "string"}}, "title": "MX Vehicle Check Report Settings", "type": "object"}, "create_mx_definitions-ReportSettings": {"description": "Report settings schema by report.", "properties": {"federal_match": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__mx__federal_match__Settings"}], "description": "Report settings for federal_match report.", "title": "Federal Match"}, "federal_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__mx__federal_records__Settings"}], "description": "Report settings for federal_records report.", "title": "Federal Records"}, "fiscal_info": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__mx__fiscal_info__Settings"}], "description": "Report settings for fiscal_info report.", "title": "Fiscal Info"}, "labor_history": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__mx__labor_history__Settings"}], "description": "Report settings for labor_history report.", "title": "Labor History"}, "license_status": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__mx__license_status__Settings"}], "description": "Report settings for license_status report.", "title": "License Status"}, "name_check": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__name_check__Settings"}], "description": "Report settings for name_check report.", "title": "Name Check"}, "news_search": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__news_search__Settings"}], "description": "Report settings for news_search report.", "title": "News Search"}, "nss": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__mx__nss__Settings"}], "description": "Report settings for nss report.", "title": "Nss"}, "professional_license": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__mx__professional_license__Settings"}], "description": "Report settings for professional_license report.", "title": "Professional License"}, "rfc": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__mx__rfc__Settings"}], "description": "Report settings for rfc report.", "title": "Rfc"}, "sanctions": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__sanctions__Settings"}], "description": "Sanctions Report Settings", "title": "Sanctions"}, "state_match": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__mx__state_match__Settings"}], "description": "Report settings for state_match report.", "title": "State Match"}, "vehicle_check": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__mx__vehicle_check__Settings"}], "description": "Report settings for vehicle_check report.", "title": "Vehicle Check"}}, "title": "ReportSettings", "type": "object"}, "create_mx_definitions-Reports": {"description": "Available reports for Mexico persons.", "properties": {"criminal": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "This report is deprecated. **Depends On** details from the `curp` report(s).", "title": "Criminal", "x-depends-on-reports": ["curp"]}, "curp": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks `document_id`.", "title": "Curp", "x-depends-on-reports": []}, "dob_check": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks `dob` provided against `dob` registered. Available only for *Cedula de Ciudadania* documents issued by [*TSE*](https://www.tse.go.cr/). **Depends On** details from the `curp` report(s).", "title": "Date of Birth Check", "x-depends-on-reports": ["curp"]}, "federal_match": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Federal Courts for criminal records. **Depends On** details from the `curp` report(s).", "title": "Federal Match", "x-depends-on-reports": ["curp"]}, "federal_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Federal Courts for criminal and civil records.", "title": "Federal Records", "x-depends-on-reports": []}, "fiscal_info": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "This report is deprecated.", "title": "Fiscal Info", "x-depends-on-reports": []}, "labor_history": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks for labor history of a person. Please note that this report requires `nss` to be enabled or provide a valid `nss` value. **Depends On** details from the `curp` report(s).", "title": "Labor History", "x-depends-on-reports": ["curp"]}, "license_status": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Driver's License status.\nSome fields are required depending on the `drivers_license_issuer` value:\n- **MX-MEX**, **MX-GUA** and **MX-CMX** require `drivers_license_id`\n- **MX-NLE** requires `drivers_license_id` and `drivers_license_verification`\n- **MX-PUE** requries `drivers_license_id` and `drivers_license_issue_date`\n\n **Depends On** details from the `curp` report(s).", "title": "License Status", "x-depends-on-reports": ["curp"]}, "name_check": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks `full_name` provided against `full_name` registered. **Depends On** details from the `curp` report(s).", "title": "Name check", "x-depends-on-reports": ["curp"]}, "news_search": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks criminal and non-criminal information about a person.", "title": "News Search", "x-depends-on-reports": []}, "nss": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Social Security registration and number. **Depends On** details from the `curp` report(s).", "title": "NSS", "x-depends-on-reports": ["curp"]}, "professional_license": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Check for a professional license. **Depends On** details from the `curp` report(s).", "title": "Professional License", "x-depends-on-reports": ["curp"]}, "rfc": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Tax ID number. **Depends On** details from the `curp` report(s).", "title": "RFC", "x-depends-on-reports": ["curp"]}, "sanctions": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks sanctions reports from UN, OFAC, EEAS and World Bank. **Depends On** details from the `curp` report(s).", "title": "Sanctions", "x-depends-on-reports": ["curp"]}, "social_media": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "This report is deprecated.", "title": "Social Media", "x-depends-on-reports": []}, "state_match": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks State Courts for criminal records. **Depends On** details from the `curp` report(s).", "title": "State Match", "x-depends-on-reports": ["curp"]}, "us_match": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks for criminal records in the United States (US). **Depends On** details from the `curp` report(s).", "title": "US Match", "x-depends-on-reports": ["curp"]}, "vehicle_check": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Check if a vehicle has records of having been stolen.", "title": "Vehicle Check", "x-depends-on-reports": []}, "verify_cfdi": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "This report is deprecated.", "title": "Verify CFDI", "x-depends-on-reports": []}}, "title": "Reports", "type": "object"}, "create_mx": {"definitions": {"PersonPipeline": {"description": "Person pipeline details.", "properties": {"name": {"description": "Name of created pipeline.", "title": "Name", "type": "string"}}, "required": ["name"], "title": "Person Pipeline", "type": "object"}, "ReportEnable": {"description": "Enable or disable a report for a given person BGC.", "enum": ["enabled", "disabled"], "title": "ReportEnable", "type": "string"}, "ReportSettings": {"description": "Report settings schema by report.", "properties": {"federal_match": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__mx__federal_match__Settings"}], "description": "Report settings for federal_match report.", "title": "Federal Match"}, "federal_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__mx__federal_records__Settings"}], "description": "Report settings for federal_records report.", "title": "Federal Records"}, "fiscal_info": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__mx__fiscal_info__Settings"}], "description": "Report settings for fiscal_info report.", "title": "Fiscal Info"}, "labor_history": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__mx__labor_history__Settings"}], "description": "Report settings for labor_history report.", "title": "Labor History"}, "license_status": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__mx__license_status__Settings"}], "description": "Report settings for license_status report.", "title": "License Status"}, "name_check": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__name_check__Settings"}], "description": "Report settings for name_check report.", "title": "Name Check"}, "news_search": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__news_search__Settings"}], "description": "Report settings for news_search report.", "title": "News Search"}, "nss": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__mx__nss__Settings"}], "description": "Report settings for nss report.", "title": "Nss"}, "professional_license": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__mx__professional_license__Settings"}], "description": "Report settings for professional_license report.", "title": "Professional License"}, "rfc": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__mx__rfc__Settings"}], "description": "Report settings for rfc report.", "title": "Rfc"}, "sanctions": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__sanctions__Settings"}], "description": "Sanctions Report Settings", "title": "Sanctions"}, "state_match": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__mx__state_match__Settings"}], "description": "Report settings for state_match report.", "title": "State Match"}, "vehicle_check": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__mx__vehicle_check__Settings"}], "description": "Report settings for vehicle_check report.", "title": "Vehicle Check"}}, "title": "ReportSettings", "type": "object"}, "Reports": {"description": "Available reports for Mexico persons.", "properties": {"criminal": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "This report is deprecated. **Depends On** details from the `curp` report(s).", "title": "Criminal", "x-depends-on-reports": ["curp"]}, "curp": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks `document_id`.", "title": "Curp", "x-depends-on-reports": []}, "dob_check": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks `dob` provided against `dob` registered. Available only for *Cedula de Ciudadania* documents issued by [*TSE*](https://www.tse.go.cr/). **Depends On** details from the `curp` report(s).", "title": "Date of Birth Check", "x-depends-on-reports": ["curp"]}, "federal_match": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Federal Courts for criminal records. **Depends On** details from the `curp` report(s).", "title": "Federal Match", "x-depends-on-reports": ["curp"]}, "federal_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Federal Courts for criminal and civil records.", "title": "Federal Records", "x-depends-on-reports": []}, "fiscal_info": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "This report is deprecated.", "title": "Fiscal Info", "x-depends-on-reports": []}, "labor_history": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks for labor history of a person. Please note that this report requires `nss` to be enabled or provide a valid `nss` value. **Depends On** details from the `curp` report(s).", "title": "Labor History", "x-depends-on-reports": ["curp"]}, "license_status": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Driver's License status.\nSome fields are required depending on the `drivers_license_issuer` value:\n- **MX-MEX**, **MX-GUA** and **MX-CMX** require `drivers_license_id`\n- **MX-NLE** requires `drivers_license_id` and `drivers_license_verification`\n- **MX-PUE** requries `drivers_license_id` and `drivers_license_issue_date`\n\n **Depends On** details from the `curp` report(s).", "title": "License Status", "x-depends-on-reports": ["curp"]}, "name_check": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks `full_name` provided against `full_name` registered. **Depends On** details from the `curp` report(s).", "title": "Name check", "x-depends-on-reports": ["curp"]}, "news_search": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks criminal and non-criminal information about a person.", "title": "News Search", "x-depends-on-reports": []}, "nss": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Social Security registration and number. **Depends On** details from the `curp` report(s).", "title": "NSS", "x-depends-on-reports": ["curp"]}, "professional_license": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Check for a professional license. **Depends On** details from the `curp` report(s).", "title": "Professional License", "x-depends-on-reports": ["curp"]}, "rfc": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Tax ID number. **Depends On** details from the `curp` report(s).", "title": "RFC", "x-depends-on-reports": ["curp"]}, "sanctions": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks sanctions reports from UN, OFAC, EEAS and World Bank. **Depends On** details from the `curp` report(s).", "title": "Sanctions", "x-depends-on-reports": ["curp"]}, "social_media": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "This report is deprecated.", "title": "Social Media", "x-depends-on-reports": []}, "state_match": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks State Courts for criminal records. **Depends On** details from the `curp` report(s).", "title": "State Match", "x-depends-on-reports": ["curp"]}, "us_match": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks for criminal records in the United States (US). **Depends On** details from the `curp` report(s).", "title": "US Match", "x-depends-on-reports": ["curp"]}, "vehicle_check": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Check if a vehicle has records of having been stolen.", "title": "Vehicle Check", "x-depends-on-reports": []}, "verify_cfdi": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "This report is deprecated.", "title": "Verify CFDI", "x-depends-on-reports": []}}, "title": "Reports", "type": "object"}, "bgcapi__schemas__report_settings__common__name_check__Settings": {"description": "Report settings for name_check report.", "properties": {"name_fragment_check": {"default": false, "description": "If the report should check for name fragments instead of full name check.", "title": "Name Fragment Check", "type": "boolean"}, "name_score_min": {"default": 1, "description": "Minimum score for name match for a PASSED outcome (0.00 <= n <= 1.00).", "title": "Name Score Min", "type": "number"}}, "title": "Name Check Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__common__news_search__Settings": {"description": "Report settings for news_search report.", "properties": {"info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}}, "title": "Settings", "type": "object"}, "bgcapi__schemas__report_settings__common__sanctions__Settings": {"description": "Report settings for sanctions report.", "properties": {"name_score_min": {"default": 0.9, "description": "Minimum score for name match for a PASSED outcome (0.00 <= n <= 1.00).", "title": "Name Score Min", "type": "number"}, "show_ignored_records": {"default": false, "description": "Determine if ignored records are shown in the report details.", "title": "Show Ignored Records", "type": "boolean"}}, "title": "Sanctions Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__mx__federal_match__Settings": {"description": "Report settings for MX vehicle_check report.", "properties": {"criminal_age_majority": {"default": 13, "description": "Records older than age of this person, will be ignored.", "title": "Criminal Age Majority", "type": "integer"}, "max_record_age_years": {"default": 100, "description": "Records older than this number of years will be ignored.", "title": "Max Record Age Years", "type": "integer"}}, "title": "MX Federal Match Check Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__mx__federal_records__Settings": {"description": "Report settings for MX federal_records report.", "properties": {"age_majority": {"default": 18, "description": "Ignore files that were opened when the candidate was at a certain age. This includes files that were opened when the candidate had that age.", "title": "Age Majority", "type": "integer"}, "autoridad_whitelist": {"description": "List of string which is checked against the field `autoridad` of the records. If it is a partial match, the record is dismissed.", "items": {"type": "string"}, "title": "Autoridad Whitelist", "type": "array"}, "court_whitelist": {"description": "List of allowed strings which is checked against the field `court_id` of the records found.", "items": {"type": "string"}, "title": "Court Whitelist", "type": "array"}, "info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}, "manual_review": {"default": false, "description": "Determines if the folder should go to manual review when there are non-dismissed records found.", "title": "Manual Review", "type": "boolean"}, "max_record_age_years": {"default": 10, "description": "Records older than this number of years will be ignored.", "title": "Max Record Age Years", "type": "integer"}, "name_score_min": {"default": 0.9, "description": "Minimum score for name match (0.00 <= n <= 1.00).", "title": "Name Score Min", "type": "number"}, "search_publication_type": {"description": "Determines which type of records will be returned.", "items": {"enum": ["amparo", "penal", "civil_administrativa"], "type": "string"}, "title": "Search Publication Type", "type": "array"}, "tipo_whitelist": {"description": "List of string which is checked against the field `tipo` of the records. If it is a partial match, the record is dismissed.", "items": {"type": "string"}, "title": "Tipo Whitelist", "type": "array"}}, "title": "MX Federal Records Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__mx__fiscal_info__Settings": {"description": "Report settings schema for fiscal_info report.", "properties": {"info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}}, "title": "MX Fiscal Info Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__mx__labor_history__Settings": {"description": "Report settings schema for labor_history report.", "properties": {"info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}}, "title": "MX Labor History Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__mx__license_status__Settings": {"description": "Report settings for MX license_status report.", "properties": {"not_found_action": {"default": "INCOMPLETE", "description": "Action that should be taken if status is `not_found`.", "enum": ["FAILED", "PASSED", "INCOMPLETE", "INFO"], "title": "Not Found Action", "type": "string"}}, "title": "MX License Status Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__mx__nss__Settings": {"description": "Report settings schema for nss report.", "properties": {"info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}}, "title": "MX NSS Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__mx__professional_license__Settings": {"description": "Report settings schema for professional_license report.", "properties": {"age_majority": {"default": 18, "description": "Ignore licenses that were issued when the candidate was younger than a certain age. This will only be applied if `name_search` is enabled.", "title": "Age Majority", "type": "integer"}, "info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}, "name_score_min": {"default": 0.9, "description": "Minimum score for name match (0.00 <= n <= 1.00). This will only be applied if `name_search` is enabled.", "title": "Name Score Min", "type": "number"}, "name_search": {"default": false, "description": "Search by person names if search by CURP doesn't return results. A manual review will not be required if this is enabled.", "title": "Name Search", "type": "boolean"}}, "title": "MX Professional License Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__mx__rfc__Settings": {"description": "Report settings schema for rfc report.", "properties": {"info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}, "not_found_action": {"default": "INCOMPLETE", "description": "Action that should be taken rfc is `not_found`.", "enum": ["FAILED", "PASSED", "INCOMPLETE"], "title": "Not Found Action", "type": "string"}}, "title": "MX Rfc Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__mx__state_match__Settings": {"description": "Report settings for MX state_match report.", "properties": {"filter_results": {"default": "criminal", "description": "Filter results by criminal or non-criminal records.", "enum": ["criminal", "non-criminal", "all"], "title": "Filter Results", "type": "string"}, "show_all_items": {"default": false, "description": "Show all matching records.", "title": "Show All Items", "type": "boolean"}}, "title": "MX State Match Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__mx__vehicle_check__Settings": {"description": "Report settings for MX vehicle_check report.", "properties": {"allowed_statuses": {"default": ["Recuperado"], "description": "Filter out statuses from `robbery_reports`.", "items": {"type": "string"}, "title": "Allowed Statuses", "type": "array"}, "not_found_action": {"default": "INCOMPLETE", "description": "Action that should be taken if status is `not_found`.", "enum": ["FAILED", "PASSED", "INCOMPLETE", "INFO"], "title": "Not Found Action", "type": "string"}}, "title": "MX Vehicle Check Report Settings", "type": "object"}}, "description": "Mexico Person Schema.", "properties": {"city_locode": {"description": "2 letter country code and 3 letter location code for the city a person is located in. See the LOCODE reference.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "dob": {"description": "ISO 8601 representation of the date the person was born. **Required** for `dob_check`", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": ["dob_check"]}, "document_id": {"description": "Document ID Number for CURP. **Required** for `federal_match`, `state_match`, `us_match`, `curp`, `nss`, `rfc`, `labor_history`, `professional_license`, `criminal`, `legal_history`, `sanctions`, `dob_check` **Optional** for `name_check`, `reference_check`", "type": "string", "x-optional-for-reports": ["name_check", "reference_check"], "x-required-by-reports": ["federal_match", "state_match", "us_match", "curp", "nss", "rfc", "labor_history", "professional_license", "criminal", "legal_history", "sanctions", "dob_check"]}, "document_id_alt": {"description": "Alternate Document ID Number.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "document_id_type": {"anyOf": [{"enum": ["foreigner_card", "national_id"], "type": "string"}, {"type": "string"}], "description": "Document ID type.", "x-optional-for-reports": [], "x-required-by-reports": []}, "drivers_license_id": {"description": "Driver's license ID number. **Required** for `license_status`", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": ["license_status"]}, "drivers_license_issue_date": {"description": "Driver's license issue date. **Optional** for `license_status`", "type": "string", "x-optional-for-reports": ["license_status"], "x-required-by-reports": []}, "drivers_license_issuer": {"description": "2 letter country code and the specific id of a driver's license issuer. **Required** for `license_status`", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": ["license_status"]}, "drivers_license_verification": {"description": "Driver's License verification number. **Optional** for `license_status`", "type": "string", "x-optional-for-reports": ["license_status"], "x-required-by-reports": []}, "forenames": {"description": "Forenames of the person to be checked.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "full_name": {"description": "Full Name of the person to be checked. **Optional** for `sanctions`, `name_check`, `news_search`, `federal_records`, `reference_check`", "type": "string", "x-optional-for-reports": ["sanctions", "name_check", "news_search", "federal_records", "reference_check"], "x-required-by-reports": []}, "nss": {"description": "Social Security Number. **Optional** for `labor_history`", "type": "string", "x-optional-for-reports": ["labor_history"], "x-required-by-reports": []}, "phone": {"description": "Phone of the person to be checked.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "pipeline": {"allOf": [{"$ref": "#/components/schemas/PersonPipeline"}], "description": "Automatically enables reports and sets report_settings. It replaces `reports` and `report_settings` fields.", "x-optional-for-reports": [], "x-required-by-reports": []}, "report_settings": {"allOf": [{"$ref": "#/components/schemas/create_mx_definitions-ReportSettings"}], "description": "Custom report_settings by report.", "x-optional-for-reports": [], "x-required-by-reports": []}, "reports": {"allOf": [{"$ref": "#/components/schemas/create_mx_definitions-Reports"}], "description": "Custom report activation by enabling/disabling reports manually.", "x-optional-for-reports": [], "x-required-by-reports": []}, "surname": {"description": "Surname of the person to be checked.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "vehicle_id": {"description": "NIV or License Plate. **Required** for `vehicle_check`", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": ["vehicle_check"]}, "webhook_details": {"description": "If true, the webhook will include the report details in the response.", "type": "boolean", "x-optional-for-reports": [], "x-required-by-reports": []}, "webhook_headers": {"additionalProperties": {"type": "string"}, "description": "Webhook headers to send in the request to the webhook URL.", "type": "object", "x-optional-for-reports": [], "x-required-by-reports": []}, "webhook_url": {"description": "Webhook URL to receive notifications when this person has a folder finished.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}}, "required": [], "title": "Mexico Person Schema", "type": "object"}, "create_pa_definitions-ReportSettings": {"description": "Report settings schema by report.", "properties": {"news_search": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__news_search__Settings"}], "description": "Report settings for news search report.", "title": "News Search"}, "sanctions": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__sanctions__Settings"}], "description": "Sanctions Report Settings", "title": "Sanctions"}}, "title": "ReportSettings", "type": "object"}, "create_pa_definitions-Reports": {"description": "Available reports for Panama persons.", "properties": {"cedula_details": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Retrieve personal details associated with a cedula.", "title": "Cedula Details", "x-depends-on-reports": []}, "criminal_record": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks for criminal records.", "title": "Criminal Record", "x-depends-on-reports": []}, "drunk_driving": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Deprecated report. Will be removed soon.", "title": "Drunk Driving", "x-depends-on-reports": []}, "license_status": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Deprecated report. Will be removed soon.", "title": "License Status", "x-depends-on-reports": []}, "news_search": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks criminal and non-criminal information about a person.", "title": "News Search", "x-depends-on-reports": []}, "sanctions": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks sanctions reports from UN, OFAC, EEAS and World Bank.", "title": "Sanctions", "x-depends-on-reports": []}}, "title": "Reports", "type": "object"}, "create_pa": {"definitions": {"PersonPipeline": {"description": "Person pipeline details.", "properties": {"name": {"description": "Name of created pipeline.", "title": "Name", "type": "string"}}, "required": ["name"], "title": "Person Pipeline", "type": "object"}, "ReportEnable": {"description": "Enable or disable a report for a given person BGC.", "enum": ["enabled", "disabled"], "title": "ReportEnable", "type": "string"}, "ReportSettings": {"description": "Report settings schema by report.", "properties": {"news_search": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__news_search__Settings"}], "description": "Report settings for news search report.", "title": "News Search"}, "sanctions": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__sanctions__Settings"}], "description": "Sanctions Report Settings", "title": "Sanctions"}}, "title": "ReportSettings", "type": "object"}, "Reports": {"description": "Available reports for Panama persons.", "properties": {"cedula_details": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Retrieve personal details associated with a cedula.", "title": "Cedula Details", "x-depends-on-reports": []}, "criminal_record": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks for criminal records.", "title": "Criminal Record", "x-depends-on-reports": []}, "drunk_driving": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Deprecated report. Will be removed soon.", "title": "Drunk Driving", "x-depends-on-reports": []}, "license_status": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Deprecated report. Will be removed soon.", "title": "License Status", "x-depends-on-reports": []}, "news_search": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks criminal and non-criminal information about a person.", "title": "News Search", "x-depends-on-reports": []}, "sanctions": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks sanctions reports from UN, OFAC, EEAS and World Bank.", "title": "Sanctions", "x-depends-on-reports": []}}, "title": "Reports", "type": "object"}, "bgcapi__schemas__report_settings__common__news_search__Settings": {"description": "Report settings for news_search report.", "properties": {"info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}}, "title": "Settings", "type": "object"}, "bgcapi__schemas__report_settings__common__sanctions__Settings": {"description": "Report settings for sanctions report.", "properties": {"name_score_min": {"default": 0.9, "description": "Minimum score for name match for a PASSED outcome (0.00 <= n <= 1.00).", "title": "Name Score Min", "type": "number"}, "show_ignored_records": {"default": false, "description": "Determine if ignored records are shown in the report details.", "title": "Show Ignored Records", "type": "boolean"}}, "title": "Sanctions Report Settings", "type": "object"}}, "description": "Panama Person Schema.", "properties": {"city_locode": {"description": "2 letter country code and 3 letter location code for the city a person is located in. See the LOCODE reference.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "dob": {"description": "ISO 8601 representation of the date the person was born.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "document_id": {"description": "Document ID Number for Panama. **Required** for `license_status`, `drunk_driving`, `cedula_details` **Optional** for `reference_check`", "type": "string", "x-optional-for-reports": ["reference_check"], "x-required-by-reports": ["license_status", "drunk_driving", "cedula_details"]}, "document_id_alt": {"description": "Alternate Document ID Number.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "document_id_type": {"anyOf": [{"enum": ["foreigner_card", "national_id"], "type": "string"}, {"type": "string"}], "description": "Document ID type.", "x-optional-for-reports": [], "x-required-by-reports": []}, "drivers_license_id": {"description": "Driver's License ID control number. **Required** for `license_status`, `drunk_driving`", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": ["license_status", "drunk_driving"]}, "forenames": {"description": "Forenames of the person to be checked. **Optional** for `criminal_record`", "type": "string", "x-optional-for-reports": ["criminal_record"], "x-required-by-reports": []}, "full_name": {"description": "Full Name of the person to be checked. **Required** for `sanctions`, `news_search` **Optional** for `criminal_record`, `sanctions`, `reference_check`", "type": "string", "x-optional-for-reports": ["criminal_record", "sanctions", "reference_check"], "x-required-by-reports": ["sanctions", "news_search"]}, "phone": {"description": "Phone of the person to be checked.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "pipeline": {"allOf": [{"$ref": "#/components/schemas/PersonPipeline"}], "description": "Automatically enables reports and sets report_settings. It replaces `reports` and `report_settings` fields.", "x-optional-for-reports": [], "x-required-by-reports": []}, "report_settings": {"allOf": [{"$ref": "#/components/schemas/create_pa_definitions-ReportSettings"}], "description": "Custom report_settings setup by report manually.", "x-optional-for-reports": [], "x-required-by-reports": []}, "reports": {"allOf": [{"$ref": "#/components/schemas/create_pa_definitions-Reports"}], "description": "Custom report activation by enabling/disabling reports manually.", "x-optional-for-reports": [], "x-required-by-reports": []}, "surname": {"description": "Surname of the person to be checked. **Optional** for `criminal_record`", "type": "string", "x-optional-for-reports": ["criminal_record"], "x-required-by-reports": []}, "webhook_details": {"description": "If true, the webhook will include the report details in the response.", "type": "boolean", "x-optional-for-reports": [], "x-required-by-reports": []}, "webhook_headers": {"additionalProperties": {"type": "string"}, "description": "Webhook headers to send in the request to the webhook URL.", "type": "object", "x-optional-for-reports": [], "x-required-by-reports": []}, "webhook_url": {"description": "Webhook URL to receive notifications when this person has a folder finished.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}}, "required": ["city_locode"], "title": "Panama Person Schema", "type": "object"}, "bgcapi__schemas__report_settings__pe__dangerous_driver__Settings": {"description": "Report settings schema for dangerous_driver report.", "properties": {"not_found_action": {"default": "INCOMPLETE", "description": "Action that should be taken if license was `not_found`.", "enum": ["FAILED", "PASSED", "INCOMPLETE", "INFO"], "title": "Not Found Action", "type": "string"}}, "title": "PE Dangerous Driver Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__pe__drunk_driving__Settings": {"description": "Report settings schema for drunk_driving report.", "properties": {"not_found_action": {"default": "INCOMPLETE", "description": "Action that should be taken if license was `not_found`.", "enum": ["FAILED", "PASSED", "INCOMPLETE", "INFO"], "title": "Not Found Action", "type": "string"}}, "title": "PE Drunk Driving Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__pe__labor_certificate__Settings": {"description": "Report settings schema for labor_certificate report.", "properties": {"required_details": {"default": ["police_record_details", "judicial_record_details", "criminal_record_details"], "description": "List of `str` to be used to look at the `services_unavailable`.", "items": {"type": "string"}, "title": "Required Details", "type": "array"}}, "title": "PE Labor Certificate Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__pe__license_status__Settings": {"description": "Report settings schema for license_status report.", "properties": {"not_found_action": {"default": "INCOMPLETE", "description": "Action that should be taken if license_status is `not_found`.", "enum": ["FAILED", "PASSED", "INCOMPLETE", "INFO"], "title": "Not Found Action", "type": "string"}}, "title": "PE License Status Report Settings", "type": "object"}, "create_pe_definitions-ReportSettings": {"description": "Report settings schema by report.", "properties": {"dangerous_driver": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__pe__dangerous_driver__Settings"}], "description": "Report settings for dangerous_driver report.", "title": "Dangerous Driver"}, "drunk_driving": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__pe__drunk_driving__Settings"}], "description": "Report settings for drunk_driving report.", "title": "Drunk Driving"}, "labor_certificate": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__pe__labor_certificate__Settings"}], "description": "Report settings for labor_certificate report.", "title": "Labor Certificate"}, "license_status": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__pe__license_status__Settings"}], "description": "Report settings for license_status report.", "title": "License Status"}, "name_check": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__name_check__Settings"}], "description": "Report settings for name_check report.", "title": "Name Check"}, "news_search": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__news_search__Settings"}], "description": "Report settings for news search report.", "title": "News Search"}, "sanctions": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__sanctions__Settings"}], "description": "Sanctions Report Settings", "title": "Sanctions"}}, "title": "ReportSettings", "type": "object"}, "create_pe_definitions-Reports": {"description": "Available reports for Peru persons.", "properties": {"boletin_judicial": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks court journals (*Boletin Judicial*) from Peru Justice System (*Poder Judicial  del Per\u00fa*).", "title": "Boletin Judicial", "x-depends-on-reports": []}, "dangerous_driver": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Driver's License for Dangerous Driving fines.", "title": "Dangerous Driver", "x-depends-on-reports": []}, "dni_status": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Deprecated report. Please use `document_id_status` instead.", "title": "Dni Status", "x-depends-on-reports": []}, "document_id_status": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Document ID status.", "title": "Document Id Status", "x-depends-on-reports": []}, "drunk_driving": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Driver's License for Drunk Driving fines.", "title": "Drunk Driving", "x-depends-on-reports": []}, "foreigner_card_status": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Deprecated report. Please use `document_id_status` instead.", "title": "Foreigner Card Status", "x-depends-on-reports": []}, "justice_certificate": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Justice Certificate (*Certificado de Antecedentes Penales*).", "title": "Justice Certificate", "x-depends-on-reports": []}, "labor_certificate": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Labor Certificate (*Certificado \u00danico Laboral*).", "title": "Labor Certificate", "x-depends-on-reports": []}, "license_status": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Driver's License status.", "title": "License Status", "x-depends-on-reports": []}, "most_wanted": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Peruvian Most Wanted database.", "title": "Most Wanted", "x-depends-on-reports": []}, "name_check": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks `full_name` provided against `full_name` registered. **Depends On** details from the `document_id_status` report(s).", "title": "Name Check", "x-depends-on-reports": ["document_id_status"]}, "news_search": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks criminal and non-criminal information about a person.", "title": "News Search", "x-depends-on-reports": []}, "police_arrest": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks police news for arrests in the name of the person.", "title": "Police Arrest", "x-depends-on-reports": []}, "sanctions": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks sanctions reports from UN, OFAC, EEAS and World Bank.", "title": "Sanctions", "x-depends-on-reports": []}}, "title": "Reports", "type": "object"}, "create_pe": {"definitions": {"PersonPipeline": {"description": "Person pipeline details.", "properties": {"name": {"description": "Name of created pipeline.", "title": "Name", "type": "string"}}, "required": ["name"], "title": "Person Pipeline", "type": "object"}, "ReportEnable": {"description": "Enable or disable a report for a given person BGC.", "enum": ["enabled", "disabled"], "title": "ReportEnable", "type": "string"}, "ReportSettings": {"description": "Report settings schema by report.", "properties": {"dangerous_driver": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__pe__dangerous_driver__Settings"}], "description": "Report settings for dangerous_driver report.", "title": "Dangerous Driver"}, "drunk_driving": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__pe__drunk_driving__Settings"}], "description": "Report settings for drunk_driving report.", "title": "Drunk Driving"}, "labor_certificate": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__pe__labor_certificate__Settings"}], "description": "Report settings for labor_certificate report.", "title": "Labor Certificate"}, "license_status": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__pe__license_status__Settings"}], "description": "Report settings for license_status report.", "title": "License Status"}, "name_check": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__name_check__Settings"}], "description": "Report settings for name_check report.", "title": "Name Check"}, "news_search": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__news_search__Settings"}], "description": "Report settings for news search report.", "title": "News Search"}, "sanctions": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__sanctions__Settings"}], "description": "Sanctions Report Settings", "title": "Sanctions"}}, "title": "ReportSettings", "type": "object"}, "Reports": {"description": "Available reports for Peru persons.", "properties": {"boletin_judicial": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks court journals (*Boletin Judicial*) from Peru Justice System (*Poder Judicial  del Per\u00fa*).", "title": "Boletin Judicial", "x-depends-on-reports": []}, "dangerous_driver": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Driver's License for Dangerous Driving fines.", "title": "Dangerous Driver", "x-depends-on-reports": []}, "dni_status": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Deprecated report. Please use `document_id_status` instead.", "title": "Dni Status", "x-depends-on-reports": []}, "document_id_status": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Document ID status.", "title": "Document Id Status", "x-depends-on-reports": []}, "drunk_driving": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Driver's License for Drunk Driving fines.", "title": "Drunk Driving", "x-depends-on-reports": []}, "foreigner_card_status": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Deprecated report. Please use `document_id_status` instead.", "title": "Foreigner Card Status", "x-depends-on-reports": []}, "justice_certificate": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Justice Certificate (*Certificado de Antecedentes Penales*).", "title": "Justice Certificate", "x-depends-on-reports": []}, "labor_certificate": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Labor Certificate (*Certificado \u00danico Laboral*).", "title": "Labor Certificate", "x-depends-on-reports": []}, "license_status": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Driver's License status.", "title": "License Status", "x-depends-on-reports": []}, "most_wanted": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Peruvian Most Wanted database.", "title": "Most Wanted", "x-depends-on-reports": []}, "name_check": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks `full_name` provided against `full_name` registered. **Depends On** details from the `document_id_status` report(s).", "title": "Name Check", "x-depends-on-reports": ["document_id_status"]}, "news_search": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks criminal and non-criminal information about a person.", "title": "News Search", "x-depends-on-reports": []}, "police_arrest": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks police news for arrests in the name of the person.", "title": "Police Arrest", "x-depends-on-reports": []}, "sanctions": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks sanctions reports from UN, OFAC, EEAS and World Bank.", "title": "Sanctions", "x-depends-on-reports": []}}, "title": "Reports", "type": "object"}, "bgcapi__schemas__report_settings__common__name_check__Settings": {"description": "Report settings for name_check report.", "properties": {"name_fragment_check": {"default": false, "description": "If the report should check for name fragments instead of full name check.", "title": "Name Fragment Check", "type": "boolean"}, "name_score_min": {"default": 1, "description": "Minimum score for name match for a PASSED outcome (0.00 <= n <= 1.00).", "title": "Name Score Min", "type": "number"}}, "title": "Name Check Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__common__news_search__Settings": {"description": "Report settings for news_search report.", "properties": {"info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}}, "title": "Settings", "type": "object"}, "bgcapi__schemas__report_settings__common__sanctions__Settings": {"description": "Report settings for sanctions report.", "properties": {"name_score_min": {"default": 0.9, "description": "Minimum score for name match for a PASSED outcome (0.00 <= n <= 1.00).", "title": "Name Score Min", "type": "number"}, "show_ignored_records": {"default": false, "description": "Determine if ignored records are shown in the report details.", "title": "Show Ignored Records", "type": "boolean"}}, "title": "Sanctions Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__pe__dangerous_driver__Settings": {"description": "Report settings schema for dangerous_driver report.", "properties": {"not_found_action": {"default": "INCOMPLETE", "description": "Action that should be taken if license was `not_found`.", "enum": ["FAILED", "PASSED", "INCOMPLETE", "INFO"], "title": "Not Found Action", "type": "string"}}, "title": "PE Dangerous Driver Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__pe__drunk_driving__Settings": {"description": "Report settings schema for drunk_driving report.", "properties": {"not_found_action": {"default": "INCOMPLETE", "description": "Action that should be taken if license was `not_found`.", "enum": ["FAILED", "PASSED", "INCOMPLETE", "INFO"], "title": "Not Found Action", "type": "string"}}, "title": "PE Drunk Driving Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__pe__labor_certificate__Settings": {"description": "Report settings schema for labor_certificate report.", "properties": {"required_details": {"default": ["police_record_details", "judicial_record_details", "criminal_record_details"], "description": "List of `str` to be used to look at the `services_unavailable`.", "items": {"type": "string"}, "title": "Required Details", "type": "array"}}, "title": "PE Labor Certificate Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__pe__license_status__Settings": {"description": "Report settings schema for license_status report.", "properties": {"not_found_action": {"default": "INCOMPLETE", "description": "Action that should be taken if license_status is `not_found`.", "enum": ["FAILED", "PASSED", "INCOMPLETE", "INFO"], "title": "Not Found Action", "type": "string"}}, "title": "PE License Status Report Settings", "type": "object"}}, "description": "Peru Person Schema.", "properties": {"city_locode": {"description": "2 letter country code and 3 letter location code for the city a person is located in. See the LOCODE reference.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "dob": {"description": "ISO 8601 representation of the date the person was born. **Optional** for `document_id_status`", "type": "string", "x-optional-for-reports": ["document_id_status"], "x-required-by-reports": []}, "document_id": {"description": "Document ID Number for Peru. **Required** for `license_status`, `drunk_driving`, `dangerous_driver`, `justice_certificate`, `labor_certificate`, `document_id_status` **Optional** for `name_check`, `reference_check`", "type": "string", "x-optional-for-reports": ["name_check", "reference_check"], "x-required-by-reports": ["license_status", "drunk_driving", "dangerous_driver", "justice_certificate", "labor_certificate", "document_id_status"]}, "document_id_alt": {"description": "Alternate Document ID Number.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "document_id_type": {"anyOf": [{"enum": ["foreigner_card", "national_id", "temporary_permit"], "type": "string"}, {"type": "string"}], "description": "Document ID type. **Required** for `license_status`, `drunk_driving`, `dangerous_driver`, `labor_certificate`, `document_id_status`", "x-optional-for-reports": [], "x-required-by-reports": ["license_status", "drunk_driving", "dangerous_driver", "labor_certificate", "document_id_status"]}, "drivers_license_id": {"description": "Driver's license ID number.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "forenames": {"description": "Forenames of the person to be checked. **Optional** for `most_wanted`, `police_arrest`", "type": "string", "x-optional-for-reports": ["most_wanted", "police_arrest"], "x-required-by-reports": []}, "full_name": {"description": "Full Name of the person to be checked. **Required** for `sanctions` **Optional** for `most_wanted`, `police_arrest`, `boletin_judicial`, `sanctions`, `name_check`, `news_search`, `reference_check`", "type": "string", "x-optional-for-reports": ["most_wanted", "police_arrest", "boletin_judicial", "sanctions", "name_check", "news_search", "reference_check"], "x-required-by-reports": ["sanctions"]}, "labor_certificate_id": {"description": "Certificate id number. **Required** for `labor_certificate`", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": ["labor_certificate"]}, "labor_certificate_type": {"description": "Certificate type. **Required** for `labor_certificate`", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": ["labor_certificate"]}, "phone": {"description": "Phone of the person to be checked.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "pipeline": {"allOf": [{"$ref": "#/components/schemas/PersonPipeline"}], "description": "Automatically enables reports and sets report_settings. It replaces `reports` and `report_settings` fields.", "x-optional-for-reports": [], "x-required-by-reports": []}, "report_settings": {"allOf": [{"$ref": "#/components/schemas/create_pe_definitions-ReportSettings"}], "description": "Custom report_settings setup by report manually.", "x-optional-for-reports": [], "x-required-by-reports": []}, "reports": {"allOf": [{"$ref": "#/components/schemas/create_pe_definitions-Reports"}], "description": "Custom report activation by enabling/disabling reports manually.", "x-optional-for-reports": [], "x-required-by-reports": []}, "request_code": {"description": "Request code. **Required** for `justice_certificate`", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": ["justice_certificate"]}, "ruc": {"description": "Company tax identification unique number in Peru.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "surname": {"description": "Surname of the person to be checked. **Optional** for `most_wanted`, `police_arrest`", "type": "string", "x-optional-for-reports": ["most_wanted", "police_arrest"], "x-required-by-reports": []}, "webhook_details": {"description": "If true, the webhook will include the report details in the response.", "type": "boolean", "x-optional-for-reports": [], "x-required-by-reports": []}, "webhook_headers": {"additionalProperties": {"type": "string"}, "description": "Webhook headers to send in the request to the webhook URL.", "type": "object", "x-optional-for-reports": [], "x-required-by-reports": []}, "webhook_url": {"description": "Webhook URL to receive notifications when this person has a folder finished.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}}, "required": ["city_locode"], "title": "Peru Person Schema", "type": "object"}, "update_ar": {"definitions": {"Gender": {"description": "Possible gender for a given person BGC.", "enum": ["male", "female", "nonbinary"], "title": "Gender", "type": "string"}, "PersonPipeline": {"description": "Person pipeline details.", "properties": {"name": {"description": "Name of created pipeline.", "title": "Name", "type": "string"}}, "required": ["name"], "title": "Person Pipeline", "type": "object"}, "ReportEnable": {"description": "Enable or disable a report for a given person BGC.", "enum": ["enabled", "disabled"], "title": "ReportEnable", "type": "string"}, "ReportSettings": {"description": "Report settings schema by report.", "properties": {"criminal_search": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__ar__criminal_search__Settings"}], "description": "Report settings for criminal_search report.", "title": "Criminal Search Report Settings"}, "federal_inmates": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__ar__federal_inmates__Settings"}], "description": "Report settings for federal_inmates report.", "title": "Federal Inmates Report Settings"}, "id_status": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__ar__id_status__Settings"}], "description": "Report settings for id_status report.", "title": "Id Status Report Settings"}, "name_check": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__name_check__Settings"}], "description": "Report settings for name_check report.", "title": "Name Check"}, "national_fugitives": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__ar__national_fugitives__Settings"}], "description": "Report settings for national_fugitives report.", "title": "National Fugitives Report Settings"}, "news_search": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__news_search__Settings"}], "description": "Report settings for news_search report.", "title": "News Search"}, "sanctions": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__sanctions__Settings"}], "description": "Sanctions Report Settings", "title": "Sanctions"}}, "title": "ReportSettings", "type": "object"}, "Reports": {"description": "Available reports for Argentina persons.", "properties": {"criminal_search": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Perform a search for criminal records for the given person.", "title": "Criminal Search", "x-depends-on-reports": []}, "federal_inmates": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Perform a search for sentenced records for the given person.", "title": "Federal Inmates", "x-depends-on-reports": []}, "id_status": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Check status of the given Document ID.", "title": "ID Status", "x-depends-on-reports": []}, "name_check": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks `full_name` provided against `full_name` registered. **Depends On** details from the `id_status` report(s).", "title": "Name Check", "x-depends-on-reports": ["id_status"]}, "national_fugitives": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Perform a search in Conarc and RNR for the given person.", "title": "National Fugitives", "x-depends-on-reports": []}, "news_search": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks criminal and non-criminal information about a person.", "title": "News Search", "x-depends-on-reports": []}, "sanctions": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks sanctions reports from UN, OFAC, EEAS and World Bank.", "title": "Sanctions", "x-depends-on-reports": []}}, "title": "Reports", "type": "object"}, "SearchType": {"description": "Valid search types for criminal_search report.", "enum": ["forenames+surname", "document_id", "full_name"], "title": "SearchType", "type": "string"}, "SourceList": {"description": "Valid sources for criminal_search report.", "enum": ["boletin_pba", "boletin_rarg", "boletin_cba", "sentencias_cij", "boletin_pch", "boletin_corr", "boletin_rios", "boletin_mis", "boletin_neuq", "boletin_neg", "boletin_salt", "boletin_scz"], "title": "SourceList", "type": "string"}, "bgcapi__schemas__report_settings__ar__criminal_search__Settings": {"description": "Report settings schema for criminal_search report.", "properties": {"criminal_age_majority": {"description": "Records older than age of this person, will be ignored.", "title": "Criminal Age Majority", "type": "integer"}, "max_record_age_years": {"description": "Records older than this number of years will be ignored.", "title": "Max Record Age Years", "type": "integer"}, "name_score_min": {"default": 1, "description": "Minimum score for name match (0.00 <= n <= 1.00).", "title": "Name Score Min", "type": "number"}, "search_type": {"allOf": [{"$ref": "#/components/schemas/SearchType"}], "default": "full_name", "description": "Specific fields to be used while performing a search."}, "source_list": {"default": ["boletin_pba", "boletin_rarg", "boletin_cba", "sentencias_cij", "boletin_pch", "boletin_corr", "boletin_rios", "boletin_mis", "boletin_neuq", "boletin_neg", "boletin_salt", "boletin_scz"], "description": "Specific source to perform a search.", "items": {"$ref": "#/components/schemas/SourceList"}, "type": "array"}}, "title": "AR Criminal Search Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__ar__federal_inmates__Settings": {"description": "Report settings for federal_inmates report.", "properties": {"crime_whitelist": {"default": [], "description": "List of strings to be used to whitelist crimes. If the value is found, the record  is ignored.", "items": {"type": "string"}, "title": "Crime Whitelist", "type": "array"}, "info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}}, "title": "AR Federal Inmates Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__ar__id_status__Settings": {"description": "Report settings schema for id_status report.", "properties": {"invalid_dob_action": {"default": "INCOMPLETE", "description": "Action that should be taken if status is `invalid_dob`.", "enum": ["FAILED", "PASSED", "INCOMPLETE"], "title": "Invalid Dob Action", "type": "string"}, "invalid_document_id_action": {"default": "INCOMPLETE", "description": "Action that should be taken if status is `invalid_document_id`.", "enum": ["FAILED", "PASSED", "INCOMPLETE"], "title": "Invalid Document Id Action", "type": "string"}, "invalid_document_id_or_gender_action": {"default": "INCOMPLETE", "description": "Action that should be taken if status is `invalid_document_id_or_gender`.", "enum": ["FAILED", "PASSED", "INCOMPLETE"], "title": "Invalid Document Id Or Gender Action", "type": "string"}, "invalid_gender_action": {"default": "INCOMPLETE", "description": "Action that should be taken if status is `invalid_gender`.", "enum": ["FAILED", "PASSED", "INCOMPLETE"], "title": "Invalid Gender Action", "type": "string"}, "not_found_action": {"default": "INCOMPLETE", "description": "Action that should be taken if status is `not_found`.", "enum": ["FAILED", "PASSED", "INCOMPLETE"], "title": "Not Found Action", "type": "string"}}, "title": "AR Id Status Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__ar__national_fugitives__Settings": {"description": "Report settings for national_fugitives report.", "properties": {"crime_whitelist": {"default": ["Incumplimiento de los deberes de asistencia familiar"], "description": "List of strings to be used to whitelist crimes. If the value is found, the record  is ignored.", "items": {"type": "string"}, "title": "Crime Whitelist", "type": "array"}, "info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}}, "title": "AR National Fugitives Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__common__name_check__Settings": {"description": "Report settings for name_check report.", "properties": {"name_fragment_check": {"default": false, "description": "If the report should check for name fragments instead of full name check.", "title": "Name Fragment Check", "type": "boolean"}, "name_score_min": {"default": 1, "description": "Minimum score for name match for a PASSED outcome (0.00 <= n <= 1.00).", "title": "Name Score Min", "type": "number"}}, "title": "Name Check Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__common__news_search__Settings": {"description": "Report settings for news_search report.", "properties": {"info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}}, "title": "Settings", "type": "object"}, "bgcapi__schemas__report_settings__common__sanctions__Settings": {"description": "Report settings for sanctions report.", "properties": {"name_score_min": {"default": 0.9, "description": "Minimum score for name match for a PASSED outcome (0.00 <= n <= 1.00).", "title": "Name Score Min", "type": "number"}, "show_ignored_records": {"default": false, "description": "Determine if ignored records are shown in the report details.", "title": "Show Ignored Records", "type": "boolean"}}, "title": "Sanctions Report Settings", "type": "object"}}, "description": "Argentina Person Schema.", "properties": {"city_locode": {"description": "2 letter country code and 3 letter location code for the city a person is located in. See the LOCODE reference.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "dob": {"description": "ISO 8601 representation of the date the person was born. **Required** for `id_status`, `federal_inmates` **Optional** for `criminal_search`, `national_fugitives`", "type": "string", "x-optional-for-reports": ["criminal_search", "national_fugitives"], "x-required-by-reports": ["id_status", "federal_inmates"]}, "document_id": {"description": "Document ID Number for Argentina. **Required** for `id_status` **Optional** for `criminal_search`, `national_fugitives`, `name_check`, `reference_check`", "type": "string", "x-optional-for-reports": ["criminal_search", "national_fugitives", "name_check", "reference_check"], "x-required-by-reports": ["id_status"]}, "document_id_alt": {"description": "Alternate Document ID Number.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "document_id_type": {"anyOf": [{"enum": ["foreigner_card", "national_id"], "type": "string"}, {"type": "string"}], "description": "Document ID type.", "x-optional-for-reports": [], "x-required-by-reports": []}, "drivers_license_id": {"description": "Driver's license ID number.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "forenames": {"description": "Forenames of the person to be checked. **Required** for `federal_inmates`, `national_fugitives` **Optional** for `criminal_search`", "type": "string", "x-optional-for-reports": ["criminal_search"], "x-required-by-reports": ["federal_inmates", "national_fugitives"]}, "full_name": {"description": "Full Name of the person to be checked. **Required** for `sanctions`, `news_search` **Optional** for `criminal_search`, `sanctions`, `name_check`, `reference_check`", "type": "string", "x-optional-for-reports": ["criminal_search", "sanctions", "name_check", "reference_check"], "x-required-by-reports": ["sanctions", "news_search"]}, "gender": {"allOf": [{"$ref": "#/components/schemas/Gender"}], "description": "Gender for given person. **Required** for `id_status`", "x-optional-for-reports": [], "x-required-by-reports": ["id_status"]}, "phone": {"description": "Phone of the person to be checked.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "pipeline": {"allOf": [{"$ref": "#/components/schemas/PersonPipeline"}], "description": "Automatically enables reports and sets report_settings. It replaces `reports` and `report_settings` fields.", "x-optional-for-reports": [], "x-required-by-reports": []}, "report_settings": {"allOf": [{"$ref": "#/components/schemas/ReportSettings"}], "description": "Custom report_settings setup by report manually.", "x-optional-for-reports": [], "x-required-by-reports": []}, "reports": {"allOf": [{"$ref": "#/components/schemas/Reports"}], "description": "Custom report activation by enabling/disabling reports manually.", "x-optional-for-reports": [], "x-required-by-reports": []}, "surname": {"description": "Surname of the person to be checked. **Required** for `federal_inmates`, `national_fugitives` **Optional** for `criminal_search`", "type": "string", "x-optional-for-reports": ["criminal_search"], "x-required-by-reports": ["federal_inmates", "national_fugitives"]}, "webhook_details": {"description": "If true, the webhook will include the report details in the response.", "type": "boolean", "x-optional-for-reports": [], "x-required-by-reports": []}, "webhook_headers": {"additionalProperties": {"type": "string"}, "description": "Webhook headers to send in the request to the webhook URL.", "type": "object", "x-optional-for-reports": [], "x-required-by-reports": []}, "webhook_url": {"description": "Webhook URL to receive notifications when this person has a folder finished.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}}, "title": "Update Argentina Person Schema", "type": "object"}, "update_br": {"definitions": {"AllowedStatuses": {"description": "Valid status values.", "enum": ["REGULAR", "SUSPENSA", "TITULAR FALECIDO", "PENDENTE DE REGULARIZA\u00c7\u00c3O", "CANCELADA POR MULTIPLICIDADE", "NULA", "CANCELADA DE OF\u00cdCIO"], "title": "AllowedStatuses", "type": "string"}, "CheckType": {"description": "Valid check types.", "enum": ["cpf", "rg", "full_name"], "title": "CheckType", "type": "string"}, "CpfStatus": {"description": "Valid CPF statuses.", "enum": ["regular", "suspensa", "pendente", "nula", "cancelada_1", "cancelada_2", "cancelada_3", "cancelada_4"], "title": "CpfStatus", "type": "string"}, "DriversLicenseAddress": {"description": "Schema of drivers license's address.", "properties": {"city_name": {"title": "City Name", "type": "string"}, "complement": {"title": "Complement", "type": "string"}, "district": {"title": "District", "type": "string"}, "number": {"title": "Number", "type": "string"}, "state": {"title": "State", "type": "string"}, "street": {"title": "Street", "type": "string"}, "zip_code": {"title": "Zip Code", "type": "string"}}, "title": "DriversLicenseAddress", "type": "object"}, "DriversLicenseDoc": {"description": "Schema of drivers license's doc.", "properties": {"id_number": {"title": "Id Number", "type": "string"}, "issuing_entity": {"title": "Issuing Entity", "type": "string"}, "issuing_state": {"title": "Issuing State", "type": "string"}, "type": {"title": "Type", "type": "string"}}, "title": "DriversLicenseDoc", "type": "object"}, "DriversLicenseInfo": {"description": "Schema of drivers license's info.", "properties": {"category": {"title": "Category", "type": "string"}, "drivers_license_number": {"title": "Drivers License Number", "type": "string"}, "expiration_date": {"title": "Expiration Date", "type": "string"}, "first_license_date": {"title": "First License Date", "type": "string"}, "foreigner_national_registry": {"title": "Foreigner National Registry", "type": "string"}, "has_impediment": {"title": "Has Impediment", "type": "boolean"}, "last_issued_date": {"title": "Last Issued Date", "type": "string"}, "status_code": {"title": "Status Code", "type": "string"}}, "title": "DriversLicenseInfo", "type": "object"}, "Nationality": {"description": "Valid nationalities.", "enum": ["brazilian", "naturalized_brazilian", "foreigner", "brazilian_born_abroad"], "title": "Nationality", "type": "string"}, "PersonPipeline": {"description": "Person pipeline details.", "properties": {"name": {"description": "Name of created pipeline.", "title": "Name", "type": "string"}}, "required": ["name"], "title": "Person Pipeline", "type": "object"}, "ReportEnable": {"description": "Enable or disable a report for a given person BGC.", "enum": ["enabled", "disabled"], "title": "ReportEnable", "type": "string"}, "ReportSettings": {"description": "Report settings schema by report.", "properties": {"ac_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for ac_state_records report.", "title": "Ac State Records"}, "al_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for al_state_records report.", "title": "Al State Records"}, "am_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for am_state_records report.", "title": "Am State Records"}, "ap_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for ap_state_records report.", "title": "Ap State Records"}, "arrest_warrants": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__arrest_warrants__Settings"}], "description": "Report settings for arrest_warrants report.", "title": "Arrest Warrants"}, "ba_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for ba_state_records report.", "title": "Ba State Records"}, "ce_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for ce_state_records report.", "title": "Ce State Records"}, "cpf_status": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__cpf_status__Settings"}], "description": "Report settings for cpf_status report.", "title": "Cpf Status"}, "criminal_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__criminal_records__Settings"}], "description": "Report settings for criminal_records report.", "title": "Criminal Records"}, "detran_check": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__detran_check__Settings"}], "description": "Report settings for detran_check report.", "title": "Detran Check"}, "df_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for df_state_records report.", "title": "Df State Records"}, "es_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for es_state_records report.", "title": "Es State Records"}, "go_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for go_state_records report.", "title": "Go State Records"}, "ma_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for ma_state_records report.", "title": "Ma State Records"}, "mg_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for mg_state_records report.", "title": "Mg State Records"}, "ms_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for ms_state_records report.", "title": "Ms State Records"}, "mt_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for mt_state_records report.", "title": "Mt State Records"}, "name_check": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__name_check__Settings"}], "description": "Report settings for name_check report.", "title": "Name Check"}, "news_search": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__news_search__Settings"}], "description": "Report settings for news_search report.", "title": "News Search"}, "pa_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for pa_state_records report.", "title": "Pa State Records"}, "pb_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for pb_state_records report.", "title": "Pb State Records"}, "pe_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for pe_state_records report.", "title": "Pe State Records"}, "pi_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for pi_state_records report.", "title": "Pi State Records"}, "pr_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for pr_state_records report.", "title": "Pr State Records"}, "rj_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for rj_state_records report.", "title": "Rj State Records"}, "rn_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for rn_state_records report.", "title": "Rn State Records"}, "ro_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for ro_state_records report.", "title": "Ro State Records"}, "rr_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for rr_state_records report.", "title": "Rr State Records"}, "sanctions": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__sanctions__Settings"}], "description": "Sanctions Report Settings", "title": "Sanctions"}, "sc_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for sc_state_records report.", "title": "Sc State Records"}, "se_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for se_state_records report.", "title": "Se State Records"}, "sp_state_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__state_records__Settings"}], "description": "Report settings for sp_state_records report.", "title": "Sp State Records"}}, "title": "ReportSettings", "type": "object"}, "Reports": {"description": "Available reports for Brazil persons.", "properties": {"ac_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Acre state court (TJAC).", "title": "AC State Records", "x-depends-on-reports": []}, "al_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Alagoas state court (TJAL).", "title": "AL State Records", "x-depends-on-reports": []}, "am_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Amazonas state court (TJAM).", "title": "AM State Records", "x-depends-on-reports": []}, "ap_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Amap\u00e1 state court (TJAP).", "title": "AP State Records", "x-depends-on-reports": []}, "arrest_warrants": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks for arrest warrants at the *Arrest Warrants National Records* (BNMP). **Depends On** details from the `cpf_status` report(s).", "title": "Arrest Warrants", "x-depends-on-reports": ["cpf_status"]}, "ba_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Bahia state court (TJBA).", "title": "BA State Records", "x-depends-on-reports": []}, "ce_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Cear\u00e1 state court (TJCE).", "title": "CE State Records", "x-depends-on-reports": []}, "cpf_status": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Validates a CPF number (`document_id`) and retrieves the personal data from Receita Federal database.", "title": "Cpf Status", "x-depends-on-reports": []}, "criminal_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks for criminal records at the *Unified Electronic Executions System* (SEEU). **Depends On** details from the `cpf_status` report(s).", "title": "Criminal Records", "x-depends-on-reports": ["cpf_status"]}, "detran_check": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "This report is deprecated.", "title": "SERPRO Detran Check", "x-depends-on-reports": []}, "df_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Distrito Federal state court (TJDF).", "title": "DF State Records", "x-depends-on-reports": []}, "dob_check": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks `dob` provided against `dob` registered in the Receita Federal database. **Depends On** details from the `cpf_status` report(s).", "title": "Date of birth Check", "x-depends-on-reports": ["cpf_status"]}, "es_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Esp\u00edrito Santo state court (TJES).", "title": "ES State Records", "x-depends-on-reports": []}, "esocial": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "This report is deprecated.", "title": "eSocial Registry", "x-depends-on-reports": []}, "go_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Goi\u00e1s state court (TJGO).", "title": "GO State Records", "x-depends-on-reports": []}, "ma_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Maranh\u00e3o state court (TJMA).", "title": "MA State Records", "x-depends-on-reports": []}, "mg_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Minas Gerais state court (TJMG).", "title": "MG State Records", "x-depends-on-reports": []}, "ms_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Mato Grosso do Sul state court (TJMS).", "title": "MS State Records", "x-depends-on-reports": []}, "mt_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Mato Grosso state court (TJMT).", "title": "MT State Records", "x-depends-on-reports": []}, "name_check": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks `full_name` provided against `full_name` registered. **Depends On** details from the `cpf_status` report(s).", "title": "Name Check", "x-depends-on-reports": ["cpf_status"]}, "national_criminal_record": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Deprecated report.", "title": "National Criminal Record", "x-depends-on-reports": []}, "news_search": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks criminal and non-criminal information about a person.", "title": "News Search", "x-depends-on-reports": []}, "pa_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Par\u00e1 state court (TJPA).", "title": "PA State Records", "x-depends-on-reports": []}, "pb_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Para\u00edba state court (TJPB).", "title": "PB State Records", "x-depends-on-reports": []}, "pe_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Pernambuco state court (TJPE).", "title": "PE State Records", "x-depends-on-reports": []}, "pi_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Piau\u00ed state court (TJPI).", "title": "PI State Records", "x-depends-on-reports": []}, "police_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Federal Police for a negative criminal certificate. **Depends On** details from the `cpf_status` report(s).", "title": "Police Records", "x-depends-on-reports": ["cpf_status"]}, "pr_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Paran\u00e1 state court (TJPR).", "title": "PR State Records", "x-depends-on-reports": []}, "rj_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Rio de Janeiro state court (TJRJ).", "title": "RJ State Records", "x-depends-on-reports": []}, "rn_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Rio Grande do Norte state court (TJRN).", "title": "RN State Records", "x-depends-on-reports": []}, "ro_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Rond\u00f4nia state court (TJRO).", "title": "RO State Records", "x-depends-on-reports": []}, "rr_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Roraima state court (TJRR).", "title": "RR State Records", "x-depends-on-reports": []}, "sanctions": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks sanctions reports from UN, OFAC, EEAS and World Bank. **Depends On** details from the `cpf_status` report(s).", "title": "Sanctions", "x-depends-on-reports": ["cpf_status"]}, "sc_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Santa Catarina state court (TJSC).", "title": "SC State Records", "x-depends-on-reports": []}, "se_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in Sergipe state court (TJSE).", "title": "SE State Records", "x-depends-on-reports": []}, "sp_state_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Search for records in S\u00e3o Paulo state court (TJSP).", "title": "SP State Records", "x-depends-on-reports": []}}, "title": "Reports", "type": "object"}, "bgcapi__schemas__report_settings__br__arrest_warrants__CheckTypes": {"description": "Valid check types.", "enum": ["cpf", "rg", "full_name"], "title": "CheckTypes", "type": "string"}, "bgcapi__schemas__report_settings__br__arrest_warrants__Settings": {"description": "Report settings schema for arrest_warrants report.", "properties": {"check_types": {"default": ["cpf"], "description": "Data that should be used in the arrest warrants search.", "items": {"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__arrest_warrants__CheckTypes"}, "type": "array"}, "manual_review": {"default": false, "description": "If Manual Review should be enabled for the report.", "title": "Manual Review", "type": "boolean"}}, "title": "BR Arrest Warrants Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__br__cpf_status__Settings": {"description": "Report settings schema for cpf_status report.", "properties": {"allowed_statuses": {"default": ["REGULAR"], "description": "Status that are allowed for a PASSED outcome.", "items": {"$ref": "#/components/schemas/AllowedStatuses"}, "type": "array"}}, "title": "BR Cpf Status Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__br__criminal_records__CheckTypes": {"description": "Valid type values.", "enum": ["document_id", "full_name"], "title": "CheckTypes", "type": "string"}, "bgcapi__schemas__report_settings__br__criminal_records__Settings": {"description": "Report settings schema for criminal_records report.", "properties": {"check_types": {"default": ["document_id"], "description": "Data that should be used in the criminal records search.", "items": {"$ref": "#/components/schemas/bgcapi__schemas__report_settings__br__criminal_records__CheckTypes"}, "type": "array"}, "manual_review": {"default": false, "description": "If Manual Review should be enabled for the report.", "title": "Manual Review", "type": "boolean"}}, "title": "BR Criminal Records Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__br__detran_check__Settings": {"description": "Report settings schema for detran_check report.", "properties": {"info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}}, "title": "BR Detran Check Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__br__state_records__Settings": {"description": "Report settings schema for state_records report.", "properties": {"age_majority": {"default": 1, "description": "Ignore files that were opened when the candidate was at a certain age. This includes files that were opened when the candidate had that age.", "title": "Age Majority", "type": "integer"}, "check_type": {"description": "Check sources with the respective person fields.", "items": {"$ref": "#/components/schemas/CheckType"}, "type": "array"}, "court_blacklist": {"description": "List of strings that are checked in the field `court`. Prevails over `court_whitelist`, to mark a record as revelant.", "items": {"type": "string"}, "title": "Court Blacklist", "type": "array"}, "court_whitelist": {"description": "List of allowed strings that are checked in the field `court`.", "items": {"type": "string"}, "title": "Court Whitelist", "type": "array"}, "info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}, "irrelevant_roles": {"description": "List of roles that are excluded for name matching.", "items": {"type": "string"}, "title": "Irrelevant Roles", "type": "array"}, "manual_review": {"default": false, "description": "Determines if the folder should go to manual review when there are non-dismissed records found.", "title": "Manual Review", "type": "boolean"}, "max_record_age_years": {"description": "Records older than this number of years will be ignored.", "title": "Max Record Age Years", "type": "integer"}, "name_score_min": {"default": 0, "description": "Minimum score for name match (0.00 <= n <= 1.00).", "title": "Name Score Min", "type": "number"}, "process_type_blacklist": {"description": "List of strings that are checked in the field `process_type`. Prevails over `process_type_whitelist`, to mark a record as revelant.", "items": {"type": "string"}, "title": "Process Type Blacklist", "type": "array"}, "process_type_whitelist": {"description": "List of allowed strings that are checked in the field `process_type`.", "items": {"type": "string"}, "title": "Process Type Whitelist", "type": "array"}, "subject_type_blacklist": {"description": "List of strings that are checked in the field `subject_type`. Prevails over `subject_type_whitelist`, to mark a record as revelant.", "items": {"type": "string"}, "title": "Subject Type Blacklist", "type": "array"}, "subject_type_whitelist": {"description": "List of allowed strings that are checked in the field `subject_type`.", "items": {"type": "string"}, "title": "Subject Type Whitelist", "type": "array"}, "uncategorized_status": {"default": "irrelevant", "description": "Default status for records if no other report settings are matched.", "enum": ["relevant", "irrelevant"], "title": "Uncategorized Status", "type": "string"}}, "title": "BR State Records Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__common__name_check__Settings": {"description": "Report settings for name_check report.", "properties": {"name_fragment_check": {"default": false, "description": "If the report should check for name fragments instead of full name check.", "title": "Name Fragment Check", "type": "boolean"}, "name_score_min": {"default": 1, "description": "Minimum score for name match for a PASSED outcome (0.00 <= n <= 1.00).", "title": "Name Score Min", "type": "number"}}, "title": "Name Check Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__common__news_search__Settings": {"description": "Report settings for news_search report.", "properties": {"info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}}, "title": "Settings", "type": "object"}, "bgcapi__schemas__report_settings__common__sanctions__Settings": {"description": "Report settings for sanctions report.", "properties": {"name_score_min": {"default": 0.9, "description": "Minimum score for name match for a PASSED outcome (0.00 <= n <= 1.00).", "title": "Name Score Min", "type": "number"}, "show_ignored_records": {"default": false, "description": "Determine if ignored records are shown in the report details.", "title": "Show Ignored Records", "type": "boolean"}}, "title": "Sanctions Report Settings", "type": "object"}}, "description": "Brazil Person Schema.", "properties": {"address_city": {"description": "Person's address city.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "address_number": {"description": "Person's address number.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "address_postal_code": {"description": "Person's address postal code.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "address_state": {"description": "Person's address state.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "address_street": {"description": "Person's address street.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "city_locode": {"description": "2 letter country code and 3 letter location code for the city a person is located in. See the LOCODE reference.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "cpf_status": {"allOf": [{"$ref": "#/components/schemas/CpfStatus"}], "description": "Person's CPF status.", "x-optional-for-reports": [], "x-required-by-reports": []}, "dob": {"description": "ISO 8601 representation of the date the person was born. **Required** for `dob_check` **Optional** for `cpf_status`, `police_records`, `ac_state_records`, `al_state_records`, `am_state_records`, `ap_state_records`, `ba_state_records`, `ce_state_records`, `df_state_records`, `es_state_records`, `go_state_records`, `ma_state_records`, `mg_state_records`, `ms_state_records`, `mt_state_records`, `pa_state_records`, `pb_state_records`, `pe_state_records`, `pi_state_records`, `pr_state_records`, `rj_state_records`, `rn_state_records`, `ro_state_records`, `rr_state_records`, `sc_state_records`, `se_state_records`, `sp_state_records`", "type": "string", "x-optional-for-reports": ["cpf_status", "police_records", "ac_state_records", "al_state_records", "am_state_records", "ap_state_records", "ba_state_records", "ce_state_records", "df_state_records", "es_state_records", "go_state_records", "ma_state_records", "mg_state_records", "ms_state_records", "mt_state_records", "pa_state_records", "pb_state_records", "pe_state_records", "pi_state_records", "pr_state_records", "rj_state_records", "rn_state_records", "ro_state_records", "rr_state_records", "sc_state_records", "se_state_records", "sp_state_records"], "x-required-by-reports": ["dob_check"]}, "document_id": {"description": "Document ID Number for Brazil. *Cadastro de Pessoa F\u00edsica (CPF)* digits. **Required** for `cpf_status`, `dob_check`, `police_records`, `criminal_records`, `sanctions` **Optional** for `name_check`, `arrest_warrants`, `reference_check`, `ac_state_records`, `al_state_records`, `am_state_records`, `ap_state_records`, `ba_state_records`, `ce_state_records`, `df_state_records`, `es_state_records`, `go_state_records`, `ma_state_records`, `mg_state_records`, `ms_state_records`, `mt_state_records`, `pa_state_records`, `pb_state_records`, `pe_state_records`, `pi_state_records`, `pr_state_records`, `rj_state_records`, `rn_state_records`, `ro_state_records`, `rr_state_records`, `sc_state_records`, `se_state_records`, `sp_state_records`", "type": "string", "x-optional-for-reports": ["name_check", "arrest_warrants", "reference_check", "ac_state_records", "al_state_records", "am_state_records", "ap_state_records", "ba_state_records", "ce_state_records", "df_state_records", "es_state_records", "go_state_records", "ma_state_records", "mg_state_records", "ms_state_records", "mt_state_records", "pa_state_records", "pb_state_records", "pe_state_records", "pi_state_records", "pr_state_records", "rj_state_records", "rn_state_records", "ro_state_records", "rr_state_records", "sc_state_records", "se_state_records", "sp_state_records"], "x-required-by-reports": ["cpf_status", "dob_check", "police_records", "criminal_records", "sanctions"]}, "document_id_alt": {"description": "Alternate Document ID Number. **Optional** for `arrest_warrants`, `ac_state_records`, `al_state_records`, `am_state_records`, `ap_state_records`, `ba_state_records`, `ce_state_records`, `df_state_records`, `es_state_records`, `go_state_records`, `ma_state_records`, `mg_state_records`, `ms_state_records`, `mt_state_records`, `pa_state_records`, `pb_state_records`, `pe_state_records`, `pi_state_records`, `pr_state_records`, `rj_state_records`, `rn_state_records`, `ro_state_records`, `rr_state_records`, `sc_state_records`, `se_state_records`, `sp_state_records`", "type": "string", "x-optional-for-reports": ["arrest_warrants", "ac_state_records", "al_state_records", "am_state_records", "ap_state_records", "ba_state_records", "ce_state_records", "df_state_records", "es_state_records", "go_state_records", "ma_state_records", "mg_state_records", "ms_state_records", "mt_state_records", "pa_state_records", "pb_state_records", "pe_state_records", "pi_state_records", "pr_state_records", "rj_state_records", "rn_state_records", "ro_state_records", "rr_state_records", "sc_state_records", "se_state_records", "sp_state_records"], "x-required-by-reports": []}, "document_id_type": {"anyOf": [{"enum": ["foreigner_card", "national_id"], "type": "string"}, {"type": "string"}], "description": "Document ID type.", "x-optional-for-reports": [], "x-required-by-reports": []}, "drivers_license_address": {"allOf": [{"$ref": "#/components/schemas/DriversLicenseAddress"}], "description": "Person's drivers license address.", "x-optional-for-reports": [], "x-required-by-reports": []}, "drivers_license_doc": {"allOf": [{"$ref": "#/components/schemas/DriversLicenseDoc"}], "description": "Person's drivers license document.", "x-optional-for-reports": [], "x-required-by-reports": []}, "drivers_license_id": {"description": "Driver's license ID number.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "drivers_license_info": {"allOf": [{"$ref": "#/components/schemas/DriversLicenseInfo"}], "description": "Person's drivers license information.", "x-optional-for-reports": [], "x-required-by-reports": []}, "fathers_full_name": {"description": "Full Name of the Person's father. If provided, it's used for homonyms check.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "forenames": {"description": "Forenames of the person to be checked.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "full_name": {"description": "Full Name of the person to be checked. **Optional** for `name_check`, `police_records`, `arrest_warrants`, `criminal_records`, `sanctions`, `news_search`, `reference_check`, `ac_state_records`, `al_state_records`, `am_state_records`, `ap_state_records`, `ba_state_records`, `ce_state_records`, `df_state_records`, `es_state_records`, `go_state_records`, `ma_state_records`, `mg_state_records`, `ms_state_records`, `mt_state_records`, `pa_state_records`, `pb_state_records`, `pe_state_records`, `pi_state_records`, `pr_state_records`, `rj_state_records`, `rn_state_records`, `ro_state_records`, `rr_state_records`, `sc_state_records`, `se_state_records`, `sp_state_records`", "type": "string", "x-optional-for-reports": ["name_check", "police_records", "arrest_warrants", "criminal_records", "sanctions", "news_search", "reference_check", "ac_state_records", "al_state_records", "am_state_records", "ap_state_records", "ba_state_records", "ce_state_records", "df_state_records", "es_state_records", "go_state_records", "ma_state_records", "mg_state_records", "ms_state_records", "mt_state_records", "pa_state_records", "pb_state_records", "pe_state_records", "pi_state_records", "pr_state_records", "rj_state_records", "rn_state_records", "ro_state_records", "rr_state_records", "sc_state_records", "se_state_records", "sp_state_records"], "x-required-by-reports": []}, "gender": {"description": "Person's gender", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "mothers_full_name": {"description": "Full Name of the Person's mother. If provided, it's used for homonyms check.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "nationality": {"allOf": [{"$ref": "#/components/schemas/Nationality"}], "description": "Person's nationality.", "x-optional-for-reports": [], "x-required-by-reports": []}, "phone": {"description": "Phone of the person to be checked.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "pipeline": {"allOf": [{"$ref": "#/components/schemas/PersonPipeline"}], "description": "Automatically enables reports and sets report_settings. It replaces `reports` and `report_settings` fields.", "x-optional-for-reports": [], "x-required-by-reports": []}, "report_settings": {"allOf": [{"$ref": "#/components/schemas/definitions-ReportSettings"}], "description": "Custom report_settings setup by report manually.", "x-optional-for-reports": [], "x-required-by-reports": []}, "reports": {"allOf": [{"$ref": "#/components/schemas/definitions-Reports"}], "description": "Custom report activation by enabling/disabling reports manually.", "x-optional-for-reports": [], "x-required-by-reports": []}, "social_security_id": {"description": "Person's social security id", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "surname": {"description": "Surname of the person to be checked.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "webhook_details": {"description": "If true, the webhook will include the report details in the response.", "type": "boolean", "x-optional-for-reports": [], "x-required-by-reports": []}, "webhook_headers": {"additionalProperties": {"type": "string"}, "description": "Webhook headers to send in the request to the webhook URL.", "type": "object", "x-optional-for-reports": [], "x-required-by-reports": []}, "webhook_url": {"description": "Webhook URL to receive notifications when this person has a folder finished.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}}, "title": "Update Brazil Person Schema", "type": "object"}, "update_cl_definitions-ReportSettings": {"description": "Report settings schema by report.", "properties": {"mtt_taxi": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__cl__mtt_taxi__Settings"}], "description": "Report settings for mtt_taxi report.", "title": "Mtt Taxi"}, "name_check": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__name_check__Settings"}], "description": "Report settings for name_check report.", "title": "Name Check"}, "news_search": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__news_search__Settings"}], "description": "Report settings for news_search report.", "title": "News Search"}, "sanctions": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__sanctions__Settings"}], "description": "Sanctions Report Settings", "title": "Sanctions"}, "vehicle_check": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__cl__vehicle_check__Settings"}], "description": "Report settings for vehicle_check report.", "title": "Vehicle Check"}}, "title": "ReportSettings", "type": "object"}, "update_cl_definitions-Reports": {"description": "Available reports for Chile persons.", "properties": {"criminal": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks courts for criminal records.", "title": "Criminal", "x-depends-on-reports": []}, "justice_certificate": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Retrieves and checks Justice Certificate.", "title": "Justice Certificate", "x-depends-on-reports": []}, "license_status": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Driver's License status.", "title": "License Status", "x-depends-on-reports": []}, "mtt_taxi": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Retrieves all data available for the provided `license_plate`.", "title": "MTT Taxi", "x-depends-on-reports": []}, "name_check": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks `full_name` provided against `full_name` registered. **Depends On** details from the `run_status` report(s).", "title": "Name Check", "x-depends-on-reports": ["run_status"]}, "news_search": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks criminal and non-criminal information about a person.", "title": "News Search", "x-depends-on-reports": []}, "run_status": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks RUN (`document_id`) status.", "title": "Run Status", "x-depends-on-reports": []}, "sanctions": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks sanctions reports from UN, OFAC, EEAS and World Bank. **Depends On** details from the `run_status` report(s).", "title": "Sanctions", "x-depends-on-reports": ["run_status"]}, "vehicle_check": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Retrieves all data available for the provided `license_plate`.", "title": "Vehicle Check", "x-depends-on-reports": []}}, "title": "Reports", "type": "object"}, "update_cl": {"definitions": {"PersonPipeline": {"description": "Person pipeline details.", "properties": {"name": {"description": "Name of created pipeline.", "title": "Name", "type": "string"}}, "required": ["name"], "title": "Person Pipeline", "type": "object"}, "ReportEnable": {"description": "Enable or disable a report for a given person BGC.", "enum": ["enabled", "disabled"], "title": "ReportEnable", "type": "string"}, "ReportSettings": {"description": "Report settings schema by report.", "properties": {"mtt_taxi": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__cl__mtt_taxi__Settings"}], "description": "Report settings for mtt_taxi report.", "title": "Mtt Taxi"}, "name_check": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__name_check__Settings"}], "description": "Report settings for name_check report.", "title": "Name Check"}, "news_search": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__news_search__Settings"}], "description": "Report settings for news_search report.", "title": "News Search"}, "sanctions": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__sanctions__Settings"}], "description": "Sanctions Report Settings", "title": "Sanctions"}, "vehicle_check": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__cl__vehicle_check__Settings"}], "description": "Report settings for vehicle_check report.", "title": "Vehicle Check"}}, "title": "ReportSettings", "type": "object"}, "Reports": {"description": "Available reports for Chile persons.", "properties": {"criminal": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks courts for criminal records.", "title": "Criminal", "x-depends-on-reports": []}, "justice_certificate": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Retrieves and checks Justice Certificate.", "title": "Justice Certificate", "x-depends-on-reports": []}, "license_status": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Driver's License status.", "title": "License Status", "x-depends-on-reports": []}, "mtt_taxi": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Retrieves all data available for the provided `license_plate`.", "title": "MTT Taxi", "x-depends-on-reports": []}, "name_check": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks `full_name` provided against `full_name` registered. **Depends On** details from the `run_status` report(s).", "title": "Name Check", "x-depends-on-reports": ["run_status"]}, "news_search": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks criminal and non-criminal information about a person.", "title": "News Search", "x-depends-on-reports": []}, "run_status": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks RUN (`document_id`) status.", "title": "Run Status", "x-depends-on-reports": []}, "sanctions": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks sanctions reports from UN, OFAC, EEAS and World Bank. **Depends On** details from the `run_status` report(s).", "title": "Sanctions", "x-depends-on-reports": ["run_status"]}, "vehicle_check": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Retrieves all data available for the provided `license_plate`.", "title": "Vehicle Check", "x-depends-on-reports": []}}, "title": "Reports", "type": "object"}, "bgcapi__schemas__report_settings__cl__mtt_taxi__Settings": {"description": "Report settings schema for mtt_taxi report.", "properties": {"allowed_statuses": {"default": ["VIGENTE"], "description": "Status that are allowed for a PASSED outcome.", "items": {"type": "string"}, "title": "Allowed Statuses", "type": "array"}}, "title": "CL Mtt Taxi Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__cl__vehicle_check__Settings": {"description": "Report settings schema for vehicle_check report.", "properties": {"car_years_max": {"default": 20, "description": "Maximum age of the car (in years)", "title": "Car Years Max", "type": "integer"}, "ignore_recent_not_found": {"default": true, "description": "Recently issued plates sometimes can't be queried, but they use sequential letters. This setting allows approving very recent plates even if they are not found.", "title": "Ignore Recent Not Found", "type": "boolean"}, "not_found_action": {"default": "INCOMPLETE", "description": "Action that should be taken if license plate is `not_found`.", "enum": ["FAILED", "PASSED", "INCOMPLETE"], "title": "Not Found Action", "type": "string"}, "unpaid_permit_action": {"default": "PASSED", "description": "Action that should be taken if license plate does not have a paid circulation permit", "enum": ["FAILED", "PASSED"], "title": "Unpaid Permit Action", "type": "string"}}, "title": "CL Vehicle Check Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__common__name_check__Settings": {"description": "Report settings for name_check report.", "properties": {"name_fragment_check": {"default": false, "description": "If the report should check for name fragments instead of full name check.", "title": "Name Fragment Check", "type": "boolean"}, "name_score_min": {"default": 1, "description": "Minimum score for name match for a PASSED outcome (0.00 <= n <= 1.00).", "title": "Name Score Min", "type": "number"}}, "title": "Name Check Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__common__news_search__Settings": {"description": "Report settings for news_search report.", "properties": {"info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}}, "title": "Settings", "type": "object"}, "bgcapi__schemas__report_settings__common__sanctions__Settings": {"description": "Report settings for sanctions report.", "properties": {"name_score_min": {"default": 0.9, "description": "Minimum score for name match for a PASSED outcome (0.00 <= n <= 1.00).", "title": "Name Score Min", "type": "number"}, "show_ignored_records": {"default": false, "description": "Determine if ignored records are shown in the report details.", "title": "Show Ignored Records", "type": "boolean"}}, "title": "Sanctions Report Settings", "type": "object"}}, "description": "Chile Person Schema.", "properties": {"certificate_id": {"description": "Certificate code used for validation of manually issued justice records certificates. **Required** for `justice_certificate`", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": ["justice_certificate"]}, "certificate_verification": {"description": "Certificate verification code. **Required** for `justice_certificate`", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": ["justice_certificate"]}, "city_locode": {"description": "2 letter country code and 3 letter location code for the city a person is located in. See the LOCODE reference.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "dob": {"description": "ISO 8601 representation of the date the person was born.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "document_id": {"description": "Document ID Number for Chile. *Rol Unico Nacional* - RUN. **Required** for `run_status`, `justice_certificate`, `license_status`, `criminal`, `sanctions` **Optional** for `name_check`, `reference_check`", "type": "string", "x-optional-for-reports": ["name_check", "reference_check"], "x-required-by-reports": ["run_status", "justice_certificate", "license_status", "criminal", "sanctions"]}, "document_id_alt": {"description": "Alternate Document ID Number.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "document_id_type": {"anyOf": [{"enum": ["foreigner_card", "national_id"], "type": "string"}, {"type": "string"}], "description": "Document ID type.", "x-optional-for-reports": [], "x-required-by-reports": []}, "drivers_license_id": {"description": "Driver's license ID number.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "forenames": {"description": "Forenames of the person to be checked.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "full_name": {"description": "Full Name of the person to be checked. **Optional** for `criminal`, `sanctions`, `name_check`, `news_search`, `reference_check`", "type": "string", "x-optional-for-reports": ["criminal", "sanctions", "name_check", "news_search", "reference_check"], "x-required-by-reports": []}, "license_plate": {"description": "License plate. **Required** for `mtt_taxi`, `vehicle_check`", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": ["mtt_taxi", "vehicle_check"]}, "phone": {"description": "Phone of the person to be checked.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "pipeline": {"allOf": [{"$ref": "#/components/schemas/PersonPipeline"}], "description": "Automatically enables reports and sets report_settings. It replaces `reports` and `report_settings` fields.", "x-optional-for-reports": [], "x-required-by-reports": []}, "report_settings": {"allOf": [{"$ref": "#/components/schemas/update_cl_definitions-ReportSettings"}], "description": "Custom report_settings setup by report manually.", "x-optional-for-reports": [], "x-required-by-reports": []}, "reports": {"allOf": [{"$ref": "#/components/schemas/update_cl_definitions-Reports"}], "description": "Custom report activation by enabling/disabling reports manually.", "x-optional-for-reports": [], "x-required-by-reports": []}, "surname": {"description": "Surname of the person to be checked.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "webhook_details": {"description": "If true, the webhook will include the report details in the response.", "type": "boolean", "x-optional-for-reports": [], "x-required-by-reports": []}, "webhook_headers": {"additionalProperties": {"type": "string"}, "description": "Webhook headers to send in the request to the webhook URL.", "type": "object", "x-optional-for-reports": [], "x-required-by-reports": []}, "webhook_url": {"description": "Webhook URL to receive notifications when this person has a folder finished.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}}, "title": "Update Chile Person Schema", "type": "object"}, "update_co_definitions-ReportSettings": {"description": "Report settings schema by report.", "properties": {"cedula_details": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__co__cedula_details__Settings"}], "description": "Report settings for cedula_details report.", "title": "Cedula Details"}, "drunk_driving": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__co__drunk_driving__Settings"}], "description": "Report settings for drunk_driving report.", "title": "Drunk Driving"}, "fine_count": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__co__fine_count__Settings"}], "description": "Report settings for fine_count report.", "title": "Fine Count"}, "fine_debt": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__co__fine_debt__Settings"}], "description": "Report settings for fine_debt report.", "title": "Fine Debt"}, "justice_record": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__co__justice_record__Settings"}], "description": "Report settings for justice_record report.", "title": "Justice Record"}, "license_status": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__co__license_status__Settings"}], "description": "Report settings for license_status report.", "title": "License Status"}, "name_check": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__name_check__Settings"}], "description": "Report settings for name_check report.", "title": "Name Check"}, "news_search": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__news_search__Settings"}], "description": "Report settings for news_search report.", "title": "News Search"}, "process_search": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__co__process_search__Settings"}], "description": "Report settings for process_search report.", "title": "Process Search"}, "procuradoria_record": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__co__procuradoria_record__Settings"}], "description": "Report settings for procuradoria_record report.", "title": "Procuradoria Record"}, "sanctions": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__sanctions__Settings"}], "description": "Sanctions Report Settings", "title": "Sanctions"}, "vehicle_check": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__co__vehicle_check__Settings"}], "description": "Report settings for vehicle_check report.", "title": "Vehicle Check"}}, "title": "ReportSettings", "type": "object"}, "update_co_definitions-Reports": {"description": "Available reports for Colombia persons.", "properties": {"cedula_details": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Document ID (*Cedula*) and retrieves details.\nNote: `dob` field is required for `ppt`/`rumv` documents.\n", "title": "Cedula Details", "x-depends-on-reports": []}, "drunk_driving": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Driver's License for Drunk Driving fines.", "title": "Drunk Driving", "x-depends-on-reports": []}, "fine_count": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Driver's registries for fines.", "title": "Fine Count", "x-depends-on-reports": []}, "fine_debt": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Driver's registries for fine debts.", "title": "Fine Debt", "x-depends-on-reports": []}, "justice_record": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Justice System for criminal records.", "title": "Justice Record", "x-depends-on-reports": []}, "license_status": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Driver's License status.", "title": "License Status", "x-depends-on-reports": []}, "name_check": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks `full_name` provided against `full_name` registered. **Depends On** details from the `cedula_details` report(s).", "title": "Name Check", "x-depends-on-reports": ["cedula_details"]}, "news_search": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks criminal and non-criminal information about a person.", "title": "News Search", "x-depends-on-reports": []}, "police_record": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Police for criminal records.", "title": "Police Record", "x-depends-on-reports": []}, "process_search": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Process Search report for criminal records.", "title": "Process Search", "x-depends-on-reports": []}, "procuradoria_record": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks *Procuradoria* for criminal records.", "title": "Procuradoria Record", "x-depends-on-reports": []}, "sanctions": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks sanctions reports from UN, OFAC, EEAS and World Bank.", "title": "Sanctions", "x-depends-on-reports": []}, "vehicle_check": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Retrieves all data available for the provided `license_plate` or `vin`.", "title": "Vehicle Check", "x-depends-on-reports": []}}, "title": "Reports", "type": "object"}, "update_co": {"definitions": {"IgnoredByType": {"description": "Combination of conditions to ignore processes.", "properties": {"file_location": {"description": "A list of allowed file location.", "items": {"type": "string"}, "title": "File Location", "type": "array"}, "max_record_age_years": {"description": "A number which represents how old the record can be.", "title": "Max Record Age Years", "type": "integer"}, "process_subclass": {"description": "A list of allowed process subclass.", "items": {"type": "string"}, "title": "Process Subclass", "type": "array"}}, "title": "IgnoredByType", "type": "object"}, "KeywordThreshold": {"description": "Schema to map a keyword and its threshold.", "properties": {"keyword": {"description": "Crime keyword to be mapped to the respective tolerance.", "title": "Keyword", "type": "string"}, "tolerance": {"description": "Tolerance period in years for the specified keyword.", "title": "Tolerance", "type": "integer"}}, "required": ["keyword", "tolerance"], "title": "KeywordThreshold", "type": "object"}, "PersonPipeline": {"description": "Person pipeline details.", "properties": {"name": {"description": "Name of created pipeline.", "title": "Name", "type": "string"}}, "required": ["name"], "title": "Person Pipeline", "type": "object"}, "ProcessCourtLocation": {"description": "Specific location of courts.", "properties": {"city": {"title": "City", "type": "string"}, "department": {"title": "Department", "type": "string"}}, "required": ["department", "city"], "title": "ProcessCourtLocation", "type": "object"}, "ReportEnable": {"description": "Enable or disable a report for a given person BGC.", "enum": ["enabled", "disabled"], "title": "ReportEnable", "type": "string"}, "ReportSettings": {"description": "Report settings schema by report.", "properties": {"cedula_details": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__co__cedula_details__Settings"}], "description": "Report settings for cedula_details report.", "title": "Cedula Details"}, "drunk_driving": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__co__drunk_driving__Settings"}], "description": "Report settings for drunk_driving report.", "title": "Drunk Driving"}, "fine_count": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__co__fine_count__Settings"}], "description": "Report settings for fine_count report.", "title": "Fine Count"}, "fine_debt": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__co__fine_debt__Settings"}], "description": "Report settings for fine_debt report.", "title": "Fine Debt"}, "justice_record": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__co__justice_record__Settings"}], "description": "Report settings for justice_record report.", "title": "Justice Record"}, "license_status": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__co__license_status__Settings"}], "description": "Report settings for license_status report.", "title": "License Status"}, "name_check": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__name_check__Settings"}], "description": "Report settings for name_check report.", "title": "Name Check"}, "news_search": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__news_search__Settings"}], "description": "Report settings for news_search report.", "title": "News Search"}, "process_search": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__co__process_search__Settings"}], "description": "Report settings for process_search report.", "title": "Process Search"}, "procuradoria_record": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__co__procuradoria_record__Settings"}], "description": "Report settings for procuradoria_record report.", "title": "Procuradoria Record"}, "sanctions": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__sanctions__Settings"}], "description": "Sanctions Report Settings", "title": "Sanctions"}, "vehicle_check": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__co__vehicle_check__Settings"}], "description": "Report settings for vehicle_check report.", "title": "Vehicle Check"}}, "title": "ReportSettings", "type": "object"}, "Reports": {"description": "Available reports for Colombia persons.", "properties": {"cedula_details": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Document ID (*Cedula*) and retrieves details.\nNote: `dob` field is required for `ppt`/`rumv` documents.\n", "title": "Cedula Details", "x-depends-on-reports": []}, "drunk_driving": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Driver's License for Drunk Driving fines.", "title": "Drunk Driving", "x-depends-on-reports": []}, "fine_count": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Driver's registries for fines.", "title": "Fine Count", "x-depends-on-reports": []}, "fine_debt": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Driver's registries for fine debts.", "title": "Fine Debt", "x-depends-on-reports": []}, "justice_record": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Justice System for criminal records.", "title": "Justice Record", "x-depends-on-reports": []}, "license_status": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Driver's License status.", "title": "License Status", "x-depends-on-reports": []}, "name_check": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks `full_name` provided against `full_name` registered. **Depends On** details from the `cedula_details` report(s).", "title": "Name Check", "x-depends-on-reports": ["cedula_details"]}, "news_search": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks criminal and non-criminal information about a person.", "title": "News Search", "x-depends-on-reports": []}, "police_record": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Police for criminal records.", "title": "Police Record", "x-depends-on-reports": []}, "process_search": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Process Search report for criminal records.", "title": "Process Search", "x-depends-on-reports": []}, "procuradoria_record": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks *Procuradoria* for criminal records.", "title": "Procuradoria Record", "x-depends-on-reports": []}, "sanctions": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks sanctions reports from UN, OFAC, EEAS and World Bank.", "title": "Sanctions", "x-depends-on-reports": []}, "vehicle_check": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Retrieves all data available for the provided `license_plate` or `vin`.", "title": "Vehicle Check", "x-depends-on-reports": []}}, "title": "Reports", "type": "object"}, "bgcapi__schemas__report_settings__co__cedula_details__DocumentIdTypes": {"description": "Document id types.", "enum": ["national_id", "foreigner_card", "identity_card_for_minors", "special_permit", "ppt"], "title": "DocumentIdTypes", "type": "string"}, "bgcapi__schemas__report_settings__co__cedula_details__Settings": {"description": "Report settings schema for cedula_details report.", "properties": {"ignore_not_found": {"default": [], "description": "This is a list of `document_id_types` selected by client to ignore when report encounters `not_found` responses.", "items": {"$ref": "#/components/schemas/bgcapi__schemas__report_settings__co__cedula_details__DocumentIdTypes"}, "type": "array"}, "info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}}, "title": "CO Cedula Details Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__co__drunk_driving__Settings": {"description": "Report settings schema for drunk_driving report.", "properties": {"info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}}, "title": "CO Drunk Driving Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__co__fine_count__Settings": {"description": "Report settings schema for fine_count report.", "properties": {"info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}}, "title": "CO Fine Count Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__co__fine_debt__Settings": {"description": "Report settings schema for fine_debt report.", "properties": {"info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}}, "title": "CO Fine Debt Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__co__justice_record__Settings": {"description": "Report settings schema for justice_record report.", "properties": {"crime_tolerance_threshold": {"description": "The number of years defining the tolerance period for the specified `crime_keyword`. Crimes older than this period will be marked as `PASSED`. The evaluation is based on the `crime_date` field to determine the age of the crime.", "items": {"$ref": "#/components/schemas/KeywordThreshold"}, "title": "Crime Tolerance Threshold", "type": "array"}, "crime_whitelist": {"description": "List of crime names that should not fail the person. The initial field search is in the `crime` field , and if it is empty or UNKNOWN, the string will be searched in `process_type` field. It will also search in the `crime_keyword` field. The search is case-insensitive.", "items": {"type": "string"}, "title": "Crime Whitelist", "type": "array"}, "manual_review": {"default": false, "description": "Manual Review enabled/disabled for the report.", "title": "Manual Review", "type": "boolean"}}, "title": "CO Justice Record Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__co__license_status__Settings": {"description": "Report settings schema for license_status report.", "properties": {"info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}}, "title": "CO License Status Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__co__process_search__Settings": {"description": "Report settings schema for process search report.", "properties": {"appeals_allow_list": {"description": "Choose appeal types that can be ignored.", "items": {"type": "string"}, "title": "Appeals Allow List", "type": "array"}, "courts_allow_list": {"default": ["FAMILIA", "CIVIL", "ADMINISTRATIVO", "LABORAL", "LABORALES"], "description": "Choose courts that can be ignored.", "items": {"type": "string"}, "title": "Courts Allow List", "type": "array"}, "criminal_age_majority": {"default": 14, "description": "Ignore files that were opened when the candidate was at a certain age. This includes files that were opened when the candidate had the age of juvenile criminal liability.", "title": "Criminal Age Majority", "type": "integer"}, "file_location_allow_list": {"description": "Choose file location that can be ignored.", "items": {"type": "string"}, "title": "File Location Allow List", "type": "array"}, "ignored_by_type": {"allOf": [{"$ref": "#/components/schemas/IgnoredByType"}], "description": "Combination of conditions to ignore processes.", "title": "Ignored By Type"}, "info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}, "judges_allow_list": {"default": ["CIVIL", "FAMILIA", "ADMINISTRATIVO", "LABORAL"], "description": "Choose judges that can be ignored.", "items": {"type": "string"}, "title": "Judges Allow List", "type": "array"}, "name_score_min": {"default": 1, "description": "Minimum score for name match (0.00 <= n <= 1.00).", "title": "Name Score Min", "type": "number"}, "process_class_allow_list": {"description": "Choose process class that can be ignored.", "items": {"type": "string"}, "title": "Process Class Allow List", "type": "array"}, "process_courts_priority": {"default": [{"city": "Bogota", "department": "Bogota"}, {"city": "Medellin", "department": "Antioquia"}, {"city": "Cali", "department": "Valle del Cauca"}], "description": "List of ProcessCourtLocation objects that helps to be more specific in the search, avoiding to otain too many records.", "items": {"$ref": "#/components/schemas/ProcessCourtLocation"}, "title": "Process Courts Priority", "type": "array"}, "process_part_allow_list": {"default": ["Demandante", "Apoderado"], "description": "Choose process parts that can be ignored.", "items": {"type": "string"}, "title": "Process Part Allow List", "type": "array"}, "process_subclass_allow_list": {"default": ["INASISTENCIA ALIMENTARIA"], "description": "Choose process subclass that can be ignored.", "items": {"type": "string"}, "title": "Process Subclass Allow List", "type": "array"}, "process_subject_allow_list": {"default": ["INASISTENCIA ALIMENTARIA", "ADMINISTRATIVO"], "description": "Choose process subjects that can be ignored.", "items": {"type": "string"}, "title": "Process Subject Allow List", "type": "array"}, "process_type_allow_list": {"description": "Choose process type that can be ignored.", "items": {"type": "string"}, "title": "Process Type Allow List", "type": "array"}, "show_ignored_records": {"default": false, "description": "Determine if ignored records are shown in the report details.", "title": "Show Ignored Records", "type": "boolean"}}, "title": "CO Process Search Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__co__procuradoria_record__DocumentIdTypes": {"description": "Document id types.", "enum": ["national_id", "foreigner_card", "identity_card_for_minors", "special_permit"], "title": "DocumentIdTypes", "type": "string"}, "bgcapi__schemas__report_settings__co__procuradoria_record__Settings": {"description": "Report settings schema for procuradoria_record report.", "properties": {"ignore_not_found": {"default": [], "description": "This is a list of `document_id_types` selected by client to ignore when report encounters `not_found` responses.", "items": {"$ref": "#/components/schemas/bgcapi__schemas__report_settings__co__procuradoria_record__DocumentIdTypes"}, "type": "array"}}, "title": "CO Procuradoria Record Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__co__vehicle_check__Settings": {"description": "Report settings schema for vehicle_check report.", "properties": {"accepted_policy_status": {"default": [], "description": "Policy statuses that are allowed for a PASSED outcome.", "items": {"type": "string"}, "title": "Accepted Policy Status", "type": "array"}, "accepted_vehicle_class": {"default": [], "description": "Vehicle classes that are allowed for a PASSED outcome.", "items": {"type": "string"}, "title": "Accepted Vehicle Class", "type": "array"}, "accepted_vehicle_status": {"default": [], "description": "Statuses that are allowed for a PASSED outcome.", "items": {"type": "string"}, "title": "Accepted Vehicle Status", "type": "array"}, "min_model_year": {"description": "The minimum model year that are allowed for a PASSED outcome.", "title": "Min Model Year", "type": "integer"}}, "title": "CO Vehicle Check Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__common__name_check__Settings": {"description": "Report settings for name_check report.", "properties": {"name_fragment_check": {"default": false, "description": "If the report should check for name fragments instead of full name check.", "title": "Name Fragment Check", "type": "boolean"}, "name_score_min": {"default": 1, "description": "Minimum score for name match for a PASSED outcome (0.00 <= n <= 1.00).", "title": "Name Score Min", "type": "number"}}, "title": "Name Check Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__common__news_search__Settings": {"description": "Report settings for news_search report.", "properties": {"info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}}, "title": "Settings", "type": "object"}, "bgcapi__schemas__report_settings__common__sanctions__Settings": {"description": "Report settings for sanctions report.", "properties": {"name_score_min": {"default": 0.9, "description": "Minimum score for name match for a PASSED outcome (0.00 <= n <= 1.00).", "title": "Name Score Min", "type": "number"}, "show_ignored_records": {"default": false, "description": "Determine if ignored records are shown in the report details.", "title": "Show Ignored Records", "type": "boolean"}}, "title": "Sanctions Report Settings", "type": "object"}}, "description": "Colombia Person Schema.", "properties": {"city_locode": {"description": "2 letter country code and 3 letter location code for the city a person is located in. See the LOCODE reference.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "dob": {"description": "ISO 8601 representation of the date the person was born. **Optional** for `cedula_details`, `process_search`", "type": "string", "x-optional-for-reports": ["cedula_details", "process_search"], "x-required-by-reports": []}, "document_id": {"description": "Document ID Number. **Required** for `license_status`, `drunk_driving`, `fine_debt`, `fine_count`, `justice_record`, `police_record`, `cedula_details`, `procuradoria_record` **Optional** for `vehicle_check`, `name_check`, `reference_check`", "type": "string", "x-optional-for-reports": ["vehicle_check", "name_check", "reference_check"], "x-required-by-reports": ["license_status", "drunk_driving", "fine_debt", "fine_count", "justice_record", "police_record", "cedula_details", "procuradoria_record"]}, "document_id_alt": {"description": "Alternate Document ID Number.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "document_id_type": {"anyOf": [{"enum": ["diplomatic_card", "foreigner_card", "identity_card_for_minors", "national_id", "passport", "ppt", "special_permit", "civil_registry"], "type": "string"}, {"type": "string"}], "description": "Document ID type. **Required** for `license_status`, `drunk_driving`, `fine_debt`, `fine_count`, `police_record`, `cedula_details`, `procuradoria_record` **Optional** for `vehicle_check`", "x-optional-for-reports": ["vehicle_check"], "x-required-by-reports": ["license_status", "drunk_driving", "fine_debt", "fine_count", "police_record", "cedula_details", "procuradoria_record"]}, "drivers_license_id": {"description": "Driver's license ID number.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "forenames": {"description": "Forenames of the person to be checked.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "full_name": {"description": "Full Name of the person to be checked. **Required** for `sanctions` **Optional** for `sanctions`, `process_search`, `name_check`, `news_search`, `reference_check`", "type": "string", "x-optional-for-reports": ["sanctions", "process_search", "name_check", "news_search", "reference_check"], "x-required-by-reports": ["sanctions"]}, "license_plate": {"description": "License plate. **Optional** for `vehicle_check`", "type": "string", "x-optional-for-reports": ["vehicle_check"], "x-required-by-reports": []}, "phone": {"description": "Phone of the person to be checked.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "pipeline": {"allOf": [{"$ref": "#/components/schemas/PersonPipeline"}], "description": "Automatically enables reports and sets report_settings. It replaces `reports` and `report_settings` fields.", "x-optional-for-reports": [], "x-required-by-reports": []}, "report_settings": {"allOf": [{"$ref": "#/components/schemas/update_co_definitions-ReportSettings"}], "description": "Custom report_settings setup by report manually.", "x-optional-for-reports": [], "x-required-by-reports": []}, "reports": {"allOf": [{"$ref": "#/components/schemas/update_co_definitions-Reports"}], "description": "Custom report activation by enabling/disabling reports manually.", "x-optional-for-reports": [], "x-required-by-reports": []}, "surname": {"description": "Surname of the person to be checked.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "vehicle_owner_cedula": {"description": "Cedula of vehicle owner. **Optional** for `vehicle_check`", "type": "string", "x-optional-for-reports": ["vehicle_check"], "x-required-by-reports": []}, "vin": {"description": "VIN Vehicle Identification number. **Optional** for `vehicle_check`", "type": "string", "x-optional-for-reports": ["vehicle_check"], "x-required-by-reports": []}, "webhook_details": {"description": "If true, the webhook will include the report details in the response.", "type": "boolean", "x-optional-for-reports": [], "x-required-by-reports": []}, "webhook_headers": {"additionalProperties": {"type": "string"}, "description": "Webhook headers to send in the request to the webhook URL.", "type": "object", "x-optional-for-reports": [], "x-required-by-reports": []}, "webhook_url": {"description": "Webhook URL to receive notifications when this person has a folder finished.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}}, "title": "Update Colombia Person Schema", "type": "object"}, "update_cr_definitions-ReportSettings": {"description": "Report settings schema by report.", "properties": {"archivo_judicial": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__cr__archivo_judicial__Settings"}], "description": "Report settings for archivo_judicial report.", "title": "Archivo Judicial"}, "name_check": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__name_check__Settings"}], "description": "Report settings for name_check report.", "title": "Name Check"}, "news_search": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__news_search__Settings"}], "description": "Report settings for news search report.", "title": "News Search"}, "sanctions": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__sanctions__Settings"}], "description": "Sanctions Report Settings", "title": "Sanctions"}}, "title": "ReportSettings", "type": "object"}, "update_cr_definitions-Reports": {"description": "Available reports for Costa Rica persons.", "properties": {"archivo_judicial": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Judicial Archive report for criminal records. **Depends On** details from the `cedula_status` report(s).", "title": "Archivo Judicial", "x-depends-on-reports": ["cedula_status"]}, "boletin_judicial": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Justice System journals for criminal records.", "title": "Boletin Judicial", "x-depends-on-reports": []}, "cedula_status": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks `document_id`.", "title": "Cedula Status", "x-depends-on-reports": []}, "dob_check": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks `dob` provided against `dob` registered. Available only for *Cedula de Ciudadania* documents issued by [*TSE*](https://www.tse.go.cr/). **Depends On** details from the `cedula_status` report(s).", "title": "Date of birth Check", "x-depends-on-reports": ["cedula_status"]}, "name_check": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks `full_name` provided against `full_name` registered. **Depends On** details from the `cedula_status` report(s).", "title": "Name Check", "x-depends-on-reports": ["cedula_status"]}, "news_search": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks criminal and non-criminal information about a person.", "title": "News Search", "x-depends-on-reports": []}, "sanctions": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks sanctions reports from UN, OFAC, EEAS and World Bank. **Depends On** details from the `cedula_status` report(s).", "title": "Sanctions", "x-depends-on-reports": ["cedula_status"]}}, "title": "Reports", "type": "object"}, "update_cr": {"definitions": {"PersonPipeline": {"description": "Person pipeline details.", "properties": {"name": {"description": "Name of created pipeline.", "title": "Name", "type": "string"}}, "required": ["name"], "title": "Person Pipeline", "type": "object"}, "ReportEnable": {"description": "Enable or disable a report for a given person BGC.", "enum": ["enabled", "disabled"], "title": "ReportEnable", "type": "string"}, "ReportSettings": {"description": "Report settings schema by report.", "properties": {"archivo_judicial": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__cr__archivo_judicial__Settings"}], "description": "Report settings for archivo_judicial report.", "title": "Archivo Judicial"}, "name_check": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__name_check__Settings"}], "description": "Report settings for name_check report.", "title": "Name Check"}, "news_search": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__news_search__Settings"}], "description": "Report settings for news search report.", "title": "News Search"}, "sanctions": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__sanctions__Settings"}], "description": "Sanctions Report Settings", "title": "Sanctions"}}, "title": "ReportSettings", "type": "object"}, "Reports": {"description": "Available reports for Costa Rica persons.", "properties": {"archivo_judicial": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Judicial Archive report for criminal records. **Depends On** details from the `cedula_status` report(s).", "title": "Archivo Judicial", "x-depends-on-reports": ["cedula_status"]}, "boletin_judicial": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Justice System journals for criminal records.", "title": "Boletin Judicial", "x-depends-on-reports": []}, "cedula_status": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks `document_id`.", "title": "Cedula Status", "x-depends-on-reports": []}, "dob_check": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks `dob` provided against `dob` registered. Available only for *Cedula de Ciudadania* documents issued by [*TSE*](https://www.tse.go.cr/). **Depends On** details from the `cedula_status` report(s).", "title": "Date of birth Check", "x-depends-on-reports": ["cedula_status"]}, "name_check": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks `full_name` provided against `full_name` registered. **Depends On** details from the `cedula_status` report(s).", "title": "Name Check", "x-depends-on-reports": ["cedula_status"]}, "news_search": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks criminal and non-criminal information about a person.", "title": "News Search", "x-depends-on-reports": []}, "sanctions": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks sanctions reports from UN, OFAC, EEAS and World Bank. **Depends On** details from the `cedula_status` report(s).", "title": "Sanctions", "x-depends-on-reports": ["cedula_status"]}}, "title": "Reports", "type": "object"}, "bgcapi__schemas__report_settings__common__name_check__Settings": {"description": "Report settings for name_check report.", "properties": {"name_fragment_check": {"default": false, "description": "If the report should check for name fragments instead of full name check.", "title": "Name Fragment Check", "type": "boolean"}, "name_score_min": {"default": 1, "description": "Minimum score for name match for a PASSED outcome (0.00 <= n <= 1.00).", "title": "Name Score Min", "type": "number"}}, "title": "Name Check Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__common__news_search__Settings": {"description": "Report settings for news_search report.", "properties": {"info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}}, "title": "Settings", "type": "object"}, "bgcapi__schemas__report_settings__common__sanctions__Settings": {"description": "Report settings for sanctions report.", "properties": {"name_score_min": {"default": 0.9, "description": "Minimum score for name match for a PASSED outcome (0.00 <= n <= 1.00).", "title": "Name Score Min", "type": "number"}, "show_ignored_records": {"default": false, "description": "Determine if ignored records are shown in the report details.", "title": "Show Ignored Records", "type": "boolean"}}, "title": "Sanctions Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__cr__archivo_judicial__Settings": {"description": "Report settings schema for Archivo Judicial report.", "properties": {"criminal_age_majority": {"default": 18, "description": "Ignore files that were opened when the candidate was at a certain age. This includes files that were opened when the candidate had the age of juvenile criminal liability.", "title": "Criminal Age Majority", "type": "integer"}, "info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}, "max_record_age_years": {"description": "Records older than this number of years will be ignored.", "title": "Max Record Age Years", "type": "integer"}, "office_type_allow_list": {"description": "Choose offices that can be ignored.", "items": {"type": "string"}, "title": "Office Type Allow List", "type": "array"}, "process_type_allow_list": {"description": "Choose process types that can be ignored.", "items": {"type": "string"}, "title": "Process Type Allow List", "type": "array"}, "show_ignored_records": {"default": false, "description": "Determine if ignored records are shown in the report details.", "title": "Show Ignored Records", "type": "boolean"}}, "title": "CR Archivo Judicial Report Settings", "type": "object"}}, "description": "Costa Rica Person Schema.", "properties": {"city_locode": {"description": "2 letter country code and 3 letter location code for the city a person is located in. See the LOCODE reference.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "dob": {"description": "ISO 8601 representation of the date the person was born. **Required** for `dob_check`", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": ["dob_check"]}, "document_id": {"description": "Document ID Number for Costa Rica. **Required** for `cedula_status`, `boletin_judicial`, `archivo_judicial`, `dob_check`, `sanctions` **Optional** for `name_check`, `reference_check`", "type": "string", "x-optional-for-reports": ["name_check", "reference_check"], "x-required-by-reports": ["cedula_status", "boletin_judicial", "archivo_judicial", "dob_check", "sanctions"]}, "document_id_alt": {"description": "Alternate Document ID Number.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "document_id_type": {"anyOf": [{"enum": ["foreigner_card", "national_id"], "type": "string"}, {"type": "string"}], "description": "Document ID type. **Required** for `cedula_status`", "x-optional-for-reports": [], "x-required-by-reports": ["cedula_status"]}, "drivers_license_id": {"description": "Driver's license ID number.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "forenames": {"description": "Forenames of the person to be checked. **Optional** for `archivo_judicial`", "type": "string", "x-optional-for-reports": ["archivo_judicial"], "x-required-by-reports": []}, "full_name": {"description": "Full Name of the person to be checked. **Optional** for `name_check`, `sanctions`, `news_search`, `reference_check`", "type": "string", "x-optional-for-reports": ["name_check", "sanctions", "news_search", "reference_check"], "x-required-by-reports": []}, "phone": {"description": "Phone of the person to be checked.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "pipeline": {"allOf": [{"$ref": "#/components/schemas/PersonPipeline"}], "description": "Automatically enables reports and sets report_settings. It replaces `reports` and `report_settings` fields.", "x-optional-for-reports": [], "x-required-by-reports": []}, "report_settings": {"allOf": [{"$ref": "#/components/schemas/update_cr_definitions-ReportSettings"}], "description": "Custom report_settings by report.", "x-optional-for-reports": [], "x-required-by-reports": []}, "reports": {"allOf": [{"$ref": "#/components/schemas/update_cr_definitions-Reports"}], "description": "Custom report activation by enabling/disabling reports manually.", "x-optional-for-reports": [], "x-required-by-reports": []}, "surname": {"description": "Surname of the person to be checked. **Optional** for `archivo_judicial`", "type": "string", "x-optional-for-reports": ["archivo_judicial"], "x-required-by-reports": []}, "webhook_details": {"description": "If true, the webhook will include the report details in the response.", "type": "boolean", "x-optional-for-reports": [], "x-required-by-reports": []}, "webhook_headers": {"additionalProperties": {"type": "string"}, "description": "Webhook headers to send in the request to the webhook URL.", "type": "object", "x-optional-for-reports": [], "x-required-by-reports": []}, "webhook_url": {"description": "Webhook URL to receive notifications when this person has a folder finished.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}}, "title": "Update Costa Rica Person Schema", "type": "object"}, "update_ec_definitions-ReportSettings": {"description": "Report settings schema by report.", "properties": {"driving_record": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__ec__driving_record__Settings"}], "description": "Report settings for driving_record report.", "title": "Driving Record"}, "justice_record": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__ec__justice_record__Settings"}], "description": "Report settings for justice_record report.", "title": "Justice Record"}, "license_status": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__ec__license_status__Settings"}], "description": "Report settings for license_status report.", "title": "License Status"}, "name_check": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__name_check__Settings"}], "description": "Report settings for name_check report.", "title": "Name Check"}, "news_search": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__news_search__Settings"}], "description": "Report settings for news search report.", "title": "News Search"}, "sanctions": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__sanctions__Settings"}], "description": "Sanctions Report Settings", "title": "Sanctions"}}, "title": "ReportSettings", "type": "object"}, "update_ec_definitions-Reports": {"description": "Available reports for Ecuador persons.", "properties": {"cedula_details": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Document ID (*Cedula/NUI*) and retrieves details.", "title": "Cedula Details", "x-depends-on-reports": []}, "driving_record": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Driver's License records.", "title": "Driving Record", "x-depends-on-reports": []}, "justice_record": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks for records at the Justice System.", "title": "Justice Record", "x-depends-on-reports": []}, "license_status": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Driver's License status.", "title": "License Status", "x-depends-on-reports": []}, "name_check": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks `full_name` provided against `full_name` registered. **Depends On** details from the `cedula_details` report(s).", "title": "Name Check", "x-depends-on-reports": ["cedula_details"]}, "news_search": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks criminal and non-criminal information about a person.", "title": "News Search", "x-depends-on-reports": []}, "sanctions": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks sanctions reports from UN, OFAC, EEAS and World Bank. **Depends On** details from the `cedula_details` report(s).", "title": "Sanctions", "x-depends-on-reports": ["cedula_details"]}}, "title": "Reports", "type": "object"}, "update_ec": {"definitions": {"PersonPipeline": {"description": "Person pipeline details.", "properties": {"name": {"description": "Name of created pipeline.", "title": "Name", "type": "string"}}, "required": ["name"], "title": "Person Pipeline", "type": "object"}, "ReportEnable": {"description": "Enable or disable a report for a given person BGC.", "enum": ["enabled", "disabled"], "title": "ReportEnable", "type": "string"}, "ReportSettings": {"description": "Report settings schema by report.", "properties": {"driving_record": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__ec__driving_record__Settings"}], "description": "Report settings for driving_record report.", "title": "Driving Record"}, "justice_record": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__ec__justice_record__Settings"}], "description": "Report settings for justice_record report.", "title": "Justice Record"}, "license_status": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__ec__license_status__Settings"}], "description": "Report settings for license_status report.", "title": "License Status"}, "name_check": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__name_check__Settings"}], "description": "Report settings for name_check report.", "title": "Name Check"}, "news_search": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__news_search__Settings"}], "description": "Report settings for news search report.", "title": "News Search"}, "sanctions": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__sanctions__Settings"}], "description": "Sanctions Report Settings", "title": "Sanctions"}}, "title": "ReportSettings", "type": "object"}, "Reports": {"description": "Available reports for Ecuador persons.", "properties": {"cedula_details": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Document ID (*Cedula/NUI*) and retrieves details.", "title": "Cedula Details", "x-depends-on-reports": []}, "driving_record": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Driver's License records.", "title": "Driving Record", "x-depends-on-reports": []}, "justice_record": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks for records at the Justice System.", "title": "Justice Record", "x-depends-on-reports": []}, "license_status": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Driver's License status.", "title": "License Status", "x-depends-on-reports": []}, "name_check": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks `full_name` provided against `full_name` registered. **Depends On** details from the `cedula_details` report(s).", "title": "Name Check", "x-depends-on-reports": ["cedula_details"]}, "news_search": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks criminal and non-criminal information about a person.", "title": "News Search", "x-depends-on-reports": []}, "sanctions": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks sanctions reports from UN, OFAC, EEAS and World Bank. **Depends On** details from the `cedula_details` report(s).", "title": "Sanctions", "x-depends-on-reports": ["cedula_details"]}}, "title": "Reports", "type": "object"}, "bgcapi__schemas__report_settings__common__name_check__Settings": {"description": "Report settings for name_check report.", "properties": {"name_fragment_check": {"default": false, "description": "If the report should check for name fragments instead of full name check.", "title": "Name Fragment Check", "type": "boolean"}, "name_score_min": {"default": 1, "description": "Minimum score for name match for a PASSED outcome (0.00 <= n <= 1.00).", "title": "Name Score Min", "type": "number"}}, "title": "Name Check Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__common__news_search__Settings": {"description": "Report settings for news_search report.", "properties": {"info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}}, "title": "Settings", "type": "object"}, "bgcapi__schemas__report_settings__common__sanctions__Settings": {"description": "Report settings for sanctions report.", "properties": {"name_score_min": {"default": 0.9, "description": "Minimum score for name match for a PASSED outcome (0.00 <= n <= 1.00).", "title": "Name Score Min", "type": "number"}, "show_ignored_records": {"default": false, "description": "Determine if ignored records are shown in the report details.", "title": "Show Ignored Records", "type": "boolean"}}, "title": "Sanctions Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__ec__driving_record__Settings": {"description": "Report settings schema for driving_record report.", "properties": {"failed_articles_list": {"default": ["375", "376", "377", "384", "385"], "description": "List of infraction articles to result in FAILED outcome as described in the [Driving Record Outcome Workflow](https://docs.emptor.io/docs/ecuador#driving-record-outcome-workflow).", "items": {"type": "string"}, "title": "Failed Articles List", "type": "array"}, "failed_statuses": {"default": ["PENDING", "CONTESTED", "PAID", "SETTLEMENT"], "description": "List of [fine statuses](https://docs.emptor.io/docs/ecuador#fine-statuses) to be considered for a FAILED outcome.", "items": {"type": "string"}, "title": "Failed Statuses", "type": "array"}, "minimum_points": {"default": 18, "description": "Minimum score for name match for a PASSED outcome (default set to `18`).", "title": "Minimum Points", "type": "integer"}}, "title": "EC Driving Record Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__ec__justice_record__Settings": {"description": "Report settings schema for justice_record report.", "properties": {"articles_whitelist": {"default": ["ALIMENTOS"], "description": "List of strings (`str`) to be used to whitelist articles.", "items": {"type": "string"}, "title": "Articles Whitelist", "type": "array"}, "courts_whitelist": {"default": ["UNIDAD JUDICIAL CIVIL", "UNIDAD JUDICIAL DE TRABAJO", "FAMILIA"], "description": "List of strings (`str`) to be used to whitelist courts (if `str` in `court name`).", "items": {"type": "string"}, "title": "Courts Whitelist", "type": "array"}, "roles_whitelist": {"default": ["OFENDIDO"], "description": "List of strings (`str`) to be used to whitelist roles (if `str` in `parts`).", "items": {"type": "string"}, "title": "Roles Whitelist", "type": "array"}}, "title": "EC Justice Record Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__ec__license_status__Settings": {"description": "Report settings schema for license_status report.", "properties": {"required_license_types": {"default": ["B", "C", "D"], "description": "A list of the [license types](https://docs.emptor.io/docs/ecuador#drivers-license-types) that can generate a PASSED result. It is required *at least one of* the license types in the list.", "items": {"type": "string"}, "title": "Required License Types", "type": "array"}, "validity_check": {"default": true, "description": "Indicates if the validity of the driver's license should be checked by the report (*i.e.* check if the license is expire or not).", "title": "Validity Check", "type": "boolean"}}, "title": "EC License Status Report Settings", "type": "object"}}, "description": "Ecuador Person Schema.", "properties": {"city_locode": {"description": "2 letter country code and 3 letter location code for the city a person is located in. See the LOCODE reference.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "dob": {"description": "ISO 8601 representation of the date the person was born.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "document_id": {"description": "Document ID Number for Ecuador. *Numero de Cedula / NUI*. **Required** for `license_status`, `driving_record`, `justice_record`, `cedula_details`, `sanctions` **Optional** for `name_check`, `reference_check`", "type": "string", "x-optional-for-reports": ["name_check", "reference_check"], "x-required-by-reports": ["license_status", "driving_record", "justice_record", "cedula_details", "sanctions"]}, "document_id_alt": {"description": "Alternate Document ID Number.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "document_id_type": {"anyOf": [{"enum": ["foreigner_card", "national_id"], "type": "string"}, {"type": "string"}], "description": "Document ID type.", "x-optional-for-reports": [], "x-required-by-reports": []}, "drivers_license_id": {"description": "Driver's license ID number.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "forenames": {"description": "Forenames of the person to be checked.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "full_name": {"description": "Full Name of the person to be checked. **Optional** for `sanctions`, `name_check`, `news_search`, `reference_check`", "type": "string", "x-optional-for-reports": ["sanctions", "name_check", "news_search", "reference_check"], "x-required-by-reports": []}, "phone": {"description": "Phone of the person to be checked.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "pipeline": {"allOf": [{"$ref": "#/components/schemas/PersonPipeline"}], "description": "Automatically enables reports and sets report_settings. It replaces `reports` and `report_settings` fields.", "x-optional-for-reports": [], "x-required-by-reports": []}, "report_settings": {"allOf": [{"$ref": "#/components/schemas/update_ec_definitions-ReportSettings"}], "description": "Custom report_settings setup by report manually.", "x-optional-for-reports": [], "x-required-by-reports": []}, "reports": {"allOf": [{"$ref": "#/components/schemas/update_ec_definitions-Reports"}], "description": "Custom report activation by enabling/disabling reports manually.", "x-optional-for-reports": [], "x-required-by-reports": []}, "surname": {"description": "Surname of the person to be checked.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "webhook_details": {"description": "If true, the webhook will include the report details in the response.", "type": "boolean", "x-optional-for-reports": [], "x-required-by-reports": []}, "webhook_headers": {"additionalProperties": {"type": "string"}, "description": "Webhook headers to send in the request to the webhook URL.", "type": "object", "x-optional-for-reports": [], "x-required-by-reports": []}, "webhook_url": {"description": "Webhook URL to receive notifications when this person has a folder finished.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}}, "title": "Update Ecuador Person Schema", "type": "object"}, "update_mx_definitions-ReportSettings": {"description": "Report settings schema by report.", "properties": {"federal_match": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__mx__federal_match__Settings"}], "description": "Report settings for federal_match report.", "title": "Federal Match"}, "federal_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__mx__federal_records__Settings"}], "description": "Report settings for federal_records report.", "title": "Federal Records"}, "fiscal_info": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__mx__fiscal_info__Settings"}], "description": "Report settings for fiscal_info report.", "title": "Fiscal Info"}, "labor_history": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__mx__labor_history__Settings"}], "description": "Report settings for labor_history report.", "title": "Labor History"}, "license_status": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__mx__license_status__Settings"}], "description": "Report settings for license_status report.", "title": "License Status"}, "name_check": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__name_check__Settings"}], "description": "Report settings for name_check report.", "title": "Name Check"}, "news_search": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__news_search__Settings"}], "description": "Report settings for news_search report.", "title": "News Search"}, "nss": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__mx__nss__Settings"}], "description": "Report settings for nss report.", "title": "Nss"}, "professional_license": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__mx__professional_license__Settings"}], "description": "Report settings for professional_license report.", "title": "Professional License"}, "rfc": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__mx__rfc__Settings"}], "description": "Report settings for rfc report.", "title": "Rfc"}, "sanctions": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__sanctions__Settings"}], "description": "Sanctions Report Settings", "title": "Sanctions"}, "state_match": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__mx__state_match__Settings"}], "description": "Report settings for state_match report.", "title": "State Match"}, "vehicle_check": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__mx__vehicle_check__Settings"}], "description": "Report settings for vehicle_check report.", "title": "Vehicle Check"}}, "title": "ReportSettings", "type": "object"}, "update_mx_definitions-Reports": {"description": "Available reports for Mexico persons.", "properties": {"criminal": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "This report is deprecated. **Depends On** details from the `curp` report(s).", "title": "Criminal", "x-depends-on-reports": ["curp"]}, "curp": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks `document_id`.", "title": "Curp", "x-depends-on-reports": []}, "dob_check": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks `dob` provided against `dob` registered. Available only for *Cedula de Ciudadania* documents issued by [*TSE*](https://www.tse.go.cr/). **Depends On** details from the `curp` report(s).", "title": "Date of Birth Check", "x-depends-on-reports": ["curp"]}, "federal_match": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Federal Courts for criminal records. **Depends On** details from the `curp` report(s).", "title": "Federal Match", "x-depends-on-reports": ["curp"]}, "federal_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Federal Courts for criminal and civil records.", "title": "Federal Records", "x-depends-on-reports": []}, "fiscal_info": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "This report is deprecated.", "title": "Fiscal Info", "x-depends-on-reports": []}, "labor_history": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks for labor history of a person. Please note that this report requires `nss` to be enabled or provide a valid `nss` value. **Depends On** details from the `curp` report(s).", "title": "Labor History", "x-depends-on-reports": ["curp"]}, "license_status": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Driver's License status.\nSome fields are required depending on the `drivers_license_issuer` value:\n- **MX-MEX**, **MX-GUA** and **MX-CMX** require `drivers_license_id`\n- **MX-NLE** requires `drivers_license_id` and `drivers_license_verification`\n- **MX-PUE** requries `drivers_license_id` and `drivers_license_issue_date`\n\n **Depends On** details from the `curp` report(s).", "title": "License Status", "x-depends-on-reports": ["curp"]}, "name_check": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks `full_name` provided against `full_name` registered. **Depends On** details from the `curp` report(s).", "title": "Name check", "x-depends-on-reports": ["curp"]}, "news_search": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks criminal and non-criminal information about a person.", "title": "News Search", "x-depends-on-reports": []}, "nss": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Social Security registration and number. **Depends On** details from the `curp` report(s).", "title": "NSS", "x-depends-on-reports": ["curp"]}, "professional_license": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Check for a professional license. **Depends On** details from the `curp` report(s).", "title": "Professional License", "x-depends-on-reports": ["curp"]}, "rfc": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Tax ID number. **Depends On** details from the `curp` report(s).", "title": "RFC", "x-depends-on-reports": ["curp"]}, "sanctions": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks sanctions reports from UN, OFAC, EEAS and World Bank. **Depends On** details from the `curp` report(s).", "title": "Sanctions", "x-depends-on-reports": ["curp"]}, "social_media": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "This report is deprecated.", "title": "Social Media", "x-depends-on-reports": []}, "state_match": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks State Courts for criminal records. **Depends On** details from the `curp` report(s).", "title": "State Match", "x-depends-on-reports": ["curp"]}, "us_match": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks for criminal records in the United States (US). **Depends On** details from the `curp` report(s).", "title": "US Match", "x-depends-on-reports": ["curp"]}, "vehicle_check": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Check if a vehicle has records of having been stolen.", "title": "Vehicle Check", "x-depends-on-reports": []}, "verify_cfdi": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "This report is deprecated.", "title": "Verify CFDI", "x-depends-on-reports": []}}, "title": "Reports", "type": "object"}, "update_mx": {"definitions": {"PersonPipeline": {"description": "Person pipeline details.", "properties": {"name": {"description": "Name of created pipeline.", "title": "Name", "type": "string"}}, "required": ["name"], "title": "Person Pipeline", "type": "object"}, "ReportEnable": {"description": "Enable or disable a report for a given person BGC.", "enum": ["enabled", "disabled"], "title": "ReportEnable", "type": "string"}, "ReportSettings": {"description": "Report settings schema by report.", "properties": {"federal_match": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__mx__federal_match__Settings"}], "description": "Report settings for federal_match report.", "title": "Federal Match"}, "federal_records": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__mx__federal_records__Settings"}], "description": "Report settings for federal_records report.", "title": "Federal Records"}, "fiscal_info": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__mx__fiscal_info__Settings"}], "description": "Report settings for fiscal_info report.", "title": "Fiscal Info"}, "labor_history": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__mx__labor_history__Settings"}], "description": "Report settings for labor_history report.", "title": "Labor History"}, "license_status": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__mx__license_status__Settings"}], "description": "Report settings for license_status report.", "title": "License Status"}, "name_check": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__name_check__Settings"}], "description": "Report settings for name_check report.", "title": "Name Check"}, "news_search": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__news_search__Settings"}], "description": "Report settings for news_search report.", "title": "News Search"}, "nss": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__mx__nss__Settings"}], "description": "Report settings for nss report.", "title": "Nss"}, "professional_license": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__mx__professional_license__Settings"}], "description": "Report settings for professional_license report.", "title": "Professional License"}, "rfc": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__mx__rfc__Settings"}], "description": "Report settings for rfc report.", "title": "Rfc"}, "sanctions": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__sanctions__Settings"}], "description": "Sanctions Report Settings", "title": "Sanctions"}, "state_match": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__mx__state_match__Settings"}], "description": "Report settings for state_match report.", "title": "State Match"}, "vehicle_check": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__mx__vehicle_check__Settings"}], "description": "Report settings for vehicle_check report.", "title": "Vehicle Check"}}, "title": "ReportSettings", "type": "object"}, "Reports": {"description": "Available reports for Mexico persons.", "properties": {"criminal": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "This report is deprecated. **Depends On** details from the `curp` report(s).", "title": "Criminal", "x-depends-on-reports": ["curp"]}, "curp": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks `document_id`.", "title": "Curp", "x-depends-on-reports": []}, "dob_check": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks `dob` provided against `dob` registered. Available only for *Cedula de Ciudadania* documents issued by [*TSE*](https://www.tse.go.cr/). **Depends On** details from the `curp` report(s).", "title": "Date of Birth Check", "x-depends-on-reports": ["curp"]}, "federal_match": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Federal Courts for criminal records. **Depends On** details from the `curp` report(s).", "title": "Federal Match", "x-depends-on-reports": ["curp"]}, "federal_records": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Federal Courts for criminal and civil records.", "title": "Federal Records", "x-depends-on-reports": []}, "fiscal_info": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "This report is deprecated.", "title": "Fiscal Info", "x-depends-on-reports": []}, "labor_history": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks for labor history of a person. Please note that this report requires `nss` to be enabled or provide a valid `nss` value. **Depends On** details from the `curp` report(s).", "title": "Labor History", "x-depends-on-reports": ["curp"]}, "license_status": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Driver's License status.\nSome fields are required depending on the `drivers_license_issuer` value:\n- **MX-MEX**, **MX-GUA** and **MX-CMX** require `drivers_license_id`\n- **MX-NLE** requires `drivers_license_id` and `drivers_license_verification`\n- **MX-PUE** requries `drivers_license_id` and `drivers_license_issue_date`\n\n **Depends On** details from the `curp` report(s).", "title": "License Status", "x-depends-on-reports": ["curp"]}, "name_check": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks `full_name` provided against `full_name` registered. **Depends On** details from the `curp` report(s).", "title": "Name check", "x-depends-on-reports": ["curp"]}, "news_search": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks criminal and non-criminal information about a person.", "title": "News Search", "x-depends-on-reports": []}, "nss": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Social Security registration and number. **Depends On** details from the `curp` report(s).", "title": "NSS", "x-depends-on-reports": ["curp"]}, "professional_license": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Check for a professional license. **Depends On** details from the `curp` report(s).", "title": "Professional License", "x-depends-on-reports": ["curp"]}, "rfc": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Tax ID number. **Depends On** details from the `curp` report(s).", "title": "RFC", "x-depends-on-reports": ["curp"]}, "sanctions": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks sanctions reports from UN, OFAC, EEAS and World Bank. **Depends On** details from the `curp` report(s).", "title": "Sanctions", "x-depends-on-reports": ["curp"]}, "social_media": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "This report is deprecated.", "title": "Social Media", "x-depends-on-reports": []}, "state_match": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks State Courts for criminal records. **Depends On** details from the `curp` report(s).", "title": "State Match", "x-depends-on-reports": ["curp"]}, "us_match": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks for criminal records in the United States (US). **Depends On** details from the `curp` report(s).", "title": "US Match", "x-depends-on-reports": ["curp"]}, "vehicle_check": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Check if a vehicle has records of having been stolen.", "title": "Vehicle Check", "x-depends-on-reports": []}, "verify_cfdi": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "This report is deprecated.", "title": "Verify CFDI", "x-depends-on-reports": []}}, "title": "Reports", "type": "object"}, "bgcapi__schemas__report_settings__common__name_check__Settings": {"description": "Report settings for name_check report.", "properties": {"name_fragment_check": {"default": false, "description": "If the report should check for name fragments instead of full name check.", "title": "Name Fragment Check", "type": "boolean"}, "name_score_min": {"default": 1, "description": "Minimum score for name match for a PASSED outcome (0.00 <= n <= 1.00).", "title": "Name Score Min", "type": "number"}}, "title": "Name Check Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__common__news_search__Settings": {"description": "Report settings for news_search report.", "properties": {"info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}}, "title": "Settings", "type": "object"}, "bgcapi__schemas__report_settings__common__sanctions__Settings": {"description": "Report settings for sanctions report.", "properties": {"name_score_min": {"default": 0.9, "description": "Minimum score for name match for a PASSED outcome (0.00 <= n <= 1.00).", "title": "Name Score Min", "type": "number"}, "show_ignored_records": {"default": false, "description": "Determine if ignored records are shown in the report details.", "title": "Show Ignored Records", "type": "boolean"}}, "title": "Sanctions Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__mx__federal_match__Settings": {"description": "Report settings for MX vehicle_check report.", "properties": {"criminal_age_majority": {"default": 13, "description": "Records older than age of this person, will be ignored.", "title": "Criminal Age Majority", "type": "integer"}, "max_record_age_years": {"default": 100, "description": "Records older than this number of years will be ignored.", "title": "Max Record Age Years", "type": "integer"}}, "title": "MX Federal Match Check Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__mx__federal_records__Settings": {"description": "Report settings for MX federal_records report.", "properties": {"age_majority": {"default": 18, "description": "Ignore files that were opened when the candidate was at a certain age. This includes files that were opened when the candidate had that age.", "title": "Age Majority", "type": "integer"}, "autoridad_whitelist": {"description": "List of string which is checked against the field `autoridad` of the records. If it is a partial match, the record is dismissed.", "items": {"type": "string"}, "title": "Autoridad Whitelist", "type": "array"}, "court_whitelist": {"description": "List of allowed strings which is checked against the field `court_id` of the records found.", "items": {"type": "string"}, "title": "Court Whitelist", "type": "array"}, "info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}, "manual_review": {"default": false, "description": "Determines if the folder should go to manual review when there are non-dismissed records found.", "title": "Manual Review", "type": "boolean"}, "max_record_age_years": {"default": 10, "description": "Records older than this number of years will be ignored.", "title": "Max Record Age Years", "type": "integer"}, "name_score_min": {"default": 0.9, "description": "Minimum score for name match (0.00 <= n <= 1.00).", "title": "Name Score Min", "type": "number"}, "search_publication_type": {"description": "Determines which type of records will be returned.", "items": {"enum": ["amparo", "penal", "civil_administrativa"], "type": "string"}, "title": "Search Publication Type", "type": "array"}, "tipo_whitelist": {"description": "List of string which is checked against the field `tipo` of the records. If it is a partial match, the record is dismissed.", "items": {"type": "string"}, "title": "Tipo Whitelist", "type": "array"}}, "title": "MX Federal Records Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__mx__fiscal_info__Settings": {"description": "Report settings schema for fiscal_info report.", "properties": {"info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}}, "title": "MX Fiscal Info Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__mx__labor_history__Settings": {"description": "Report settings schema for labor_history report.", "properties": {"info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}}, "title": "MX Labor History Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__mx__license_status__Settings": {"description": "Report settings for MX license_status report.", "properties": {"not_found_action": {"default": "INCOMPLETE", "description": "Action that should be taken if status is `not_found`.", "enum": ["FAILED", "PASSED", "INCOMPLETE", "INFO"], "title": "Not Found Action", "type": "string"}}, "title": "MX License Status Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__mx__nss__Settings": {"description": "Report settings schema for nss report.", "properties": {"info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}}, "title": "MX NSS Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__mx__professional_license__Settings": {"description": "Report settings schema for professional_license report.", "properties": {"age_majority": {"default": 18, "description": "Ignore licenses that were issued when the candidate was younger than a certain age. This will only be applied if `name_search` is enabled.", "title": "Age Majority", "type": "integer"}, "info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}, "name_score_min": {"default": 0.9, "description": "Minimum score for name match (0.00 <= n <= 1.00). This will only be applied if `name_search` is enabled.", "title": "Name Score Min", "type": "number"}, "name_search": {"default": false, "description": "Search by person names if search by CURP doesn't return results. A manual review will not be required if this is enabled.", "title": "Name Search", "type": "boolean"}}, "title": "MX Professional License Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__mx__rfc__Settings": {"description": "Report settings schema for rfc report.", "properties": {"info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}, "not_found_action": {"default": "INCOMPLETE", "description": "Action that should be taken rfc is `not_found`.", "enum": ["FAILED", "PASSED", "INCOMPLETE"], "title": "Not Found Action", "type": "string"}}, "title": "MX Rfc Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__mx__state_match__Settings": {"description": "Report settings for MX state_match report.", "properties": {"filter_results": {"default": "criminal", "description": "Filter results by criminal or non-criminal records.", "enum": ["criminal", "non-criminal", "all"], "title": "Filter Results", "type": "string"}, "show_all_items": {"default": false, "description": "Show all matching records.", "title": "Show All Items", "type": "boolean"}}, "title": "MX State Match Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__mx__vehicle_check__Settings": {"description": "Report settings for MX vehicle_check report.", "properties": {"allowed_statuses": {"default": ["Recuperado"], "description": "Filter out statuses from `robbery_reports`.", "items": {"type": "string"}, "title": "Allowed Statuses", "type": "array"}, "not_found_action": {"default": "INCOMPLETE", "description": "Action that should be taken if status is `not_found`.", "enum": ["FAILED", "PASSED", "INCOMPLETE", "INFO"], "title": "Not Found Action", "type": "string"}}, "title": "MX Vehicle Check Report Settings", "type": "object"}}, "description": "Mexico Person Schema.", "properties": {"city_locode": {"description": "2 letter country code and 3 letter location code for the city a person is located in. See the LOCODE reference.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "dob": {"description": "ISO 8601 representation of the date the person was born. **Required** for `dob_check`", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": ["dob_check"]}, "document_id": {"description": "Document ID Number for CURP. **Required** for `federal_match`, `state_match`, `us_match`, `curp`, `nss`, `rfc`, `labor_history`, `professional_license`, `criminal`, `legal_history`, `sanctions`, `dob_check` **Optional** for `name_check`, `reference_check`", "type": "string", "x-optional-for-reports": ["name_check", "reference_check"], "x-required-by-reports": ["federal_match", "state_match", "us_match", "curp", "nss", "rfc", "labor_history", "professional_license", "criminal", "legal_history", "sanctions", "dob_check"]}, "document_id_alt": {"description": "Alternate Document ID Number.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "document_id_type": {"anyOf": [{"enum": ["foreigner_card", "national_id"], "type": "string"}, {"type": "string"}], "description": "Document ID type.", "x-optional-for-reports": [], "x-required-by-reports": []}, "drivers_license_id": {"description": "Driver's license ID number. **Required** for `license_status`", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": ["license_status"]}, "drivers_license_issue_date": {"description": "Driver's license issue date. **Optional** for `license_status`", "type": "string", "x-optional-for-reports": ["license_status"], "x-required-by-reports": []}, "drivers_license_issuer": {"description": "2 letter country code and the specific id of a driver's license issuer. **Required** for `license_status`", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": ["license_status"]}, "drivers_license_verification": {"description": "Driver's License verification number. **Optional** for `license_status`", "type": "string", "x-optional-for-reports": ["license_status"], "x-required-by-reports": []}, "forenames": {"description": "Forenames of the person to be checked.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "full_name": {"description": "Full Name of the person to be checked. **Optional** for `sanctions`, `name_check`, `news_search`, `federal_records`, `reference_check`", "type": "string", "x-optional-for-reports": ["sanctions", "name_check", "news_search", "federal_records", "reference_check"], "x-required-by-reports": []}, "nss": {"description": "Social Security Number. **Optional** for `labor_history`", "type": "string", "x-optional-for-reports": ["labor_history"], "x-required-by-reports": []}, "phone": {"description": "Phone of the person to be checked.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "pipeline": {"allOf": [{"$ref": "#/components/schemas/PersonPipeline"}], "description": "Automatically enables reports and sets report_settings. It replaces `reports` and `report_settings` fields.", "x-optional-for-reports": [], "x-required-by-reports": []}, "report_settings": {"allOf": [{"$ref": "#/components/schemas/update_mx_definitions-ReportSettings"}], "description": "Custom report_settings by report.", "x-optional-for-reports": [], "x-required-by-reports": []}, "reports": {"allOf": [{"$ref": "#/components/schemas/update_mx_definitions-Reports"}], "description": "Custom report activation by enabling/disabling reports manually.", "x-optional-for-reports": [], "x-required-by-reports": []}, "surname": {"description": "Surname of the person to be checked.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "vehicle_id": {"description": "NIV or License Plate. **Required** for `vehicle_check`", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": ["vehicle_check"]}, "webhook_details": {"description": "If true, the webhook will include the report details in the response.", "type": "boolean", "x-optional-for-reports": [], "x-required-by-reports": []}, "webhook_headers": {"additionalProperties": {"type": "string"}, "description": "Webhook headers to send in the request to the webhook URL.", "type": "object", "x-optional-for-reports": [], "x-required-by-reports": []}, "webhook_url": {"description": "Webhook URL to receive notifications when this person has a folder finished.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}}, "title": "Update Mexico Person Schema", "type": "object"}, "update_pa_definitions-ReportSettings": {"description": "Report settings schema by report.", "properties": {"news_search": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__news_search__Settings"}], "description": "Report settings for news search report.", "title": "News Search"}, "sanctions": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__sanctions__Settings"}], "description": "Sanctions Report Settings", "title": "Sanctions"}}, "title": "ReportSettings", "type": "object"}, "update_pa_definitions-Reports": {"description": "Available reports for Panama persons.", "properties": {"cedula_details": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Retrieve personal details associated with a cedula.", "title": "Cedula Details", "x-depends-on-reports": []}, "criminal_record": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks for criminal records.", "title": "Criminal Record", "x-depends-on-reports": []}, "drunk_driving": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Deprecated report. Will be removed soon.", "title": "Drunk Driving", "x-depends-on-reports": []}, "license_status": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Deprecated report. Will be removed soon.", "title": "License Status", "x-depends-on-reports": []}, "news_search": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks criminal and non-criminal information about a person.", "title": "News Search", "x-depends-on-reports": []}, "sanctions": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks sanctions reports from UN, OFAC, EEAS and World Bank.", "title": "Sanctions", "x-depends-on-reports": []}}, "title": "Reports", "type": "object"}, "update_pa": {"definitions": {"PersonPipeline": {"description": "Person pipeline details.", "properties": {"name": {"description": "Name of created pipeline.", "title": "Name", "type": "string"}}, "required": ["name"], "title": "Person Pipeline", "type": "object"}, "ReportEnable": {"description": "Enable or disable a report for a given person BGC.", "enum": ["enabled", "disabled"], "title": "ReportEnable", "type": "string"}, "ReportSettings": {"description": "Report settings schema by report.", "properties": {"news_search": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__news_search__Settings"}], "description": "Report settings for news search report.", "title": "News Search"}, "sanctions": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__sanctions__Settings"}], "description": "Sanctions Report Settings", "title": "Sanctions"}}, "title": "ReportSettings", "type": "object"}, "Reports": {"description": "Available reports for Panama persons.", "properties": {"cedula_details": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Retrieve personal details associated with a cedula.", "title": "Cedula Details", "x-depends-on-reports": []}, "criminal_record": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks for criminal records.", "title": "Criminal Record", "x-depends-on-reports": []}, "drunk_driving": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Deprecated report. Will be removed soon.", "title": "Drunk Driving", "x-depends-on-reports": []}, "license_status": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Deprecated report. Will be removed soon.", "title": "License Status", "x-depends-on-reports": []}, "news_search": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks criminal and non-criminal information about a person.", "title": "News Search", "x-depends-on-reports": []}, "sanctions": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks sanctions reports from UN, OFAC, EEAS and World Bank.", "title": "Sanctions", "x-depends-on-reports": []}}, "title": "Reports", "type": "object"}, "bgcapi__schemas__report_settings__common__news_search__Settings": {"description": "Report settings for news_search report.", "properties": {"info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}}, "title": "Settings", "type": "object"}, "bgcapi__schemas__report_settings__common__sanctions__Settings": {"description": "Report settings for sanctions report.", "properties": {"name_score_min": {"default": 0.9, "description": "Minimum score for name match for a PASSED outcome (0.00 <= n <= 1.00).", "title": "Name Score Min", "type": "number"}, "show_ignored_records": {"default": false, "description": "Determine if ignored records are shown in the report details.", "title": "Show Ignored Records", "type": "boolean"}}, "title": "Sanctions Report Settings", "type": "object"}}, "description": "Panama Person Schema.", "properties": {"city_locode": {"description": "2 letter country code and 3 letter location code for the city a person is located in. See the LOCODE reference.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "dob": {"description": "ISO 8601 representation of the date the person was born.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "document_id": {"description": "Document ID Number for Panama. **Required** for `license_status`, `drunk_driving`, `cedula_details` **Optional** for `reference_check`", "type": "string", "x-optional-for-reports": ["reference_check"], "x-required-by-reports": ["license_status", "drunk_driving", "cedula_details"]}, "document_id_alt": {"description": "Alternate Document ID Number.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "document_id_type": {"anyOf": [{"enum": ["foreigner_card", "national_id"], "type": "string"}, {"type": "string"}], "description": "Document ID type.", "x-optional-for-reports": [], "x-required-by-reports": []}, "drivers_license_id": {"description": "Driver's License ID control number. **Required** for `license_status`, `drunk_driving`", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": ["license_status", "drunk_driving"]}, "forenames": {"description": "Forenames of the person to be checked. **Optional** for `criminal_record`", "type": "string", "x-optional-for-reports": ["criminal_record"], "x-required-by-reports": []}, "full_name": {"description": "Full Name of the person to be checked. **Required** for `sanctions`, `news_search` **Optional** for `criminal_record`, `sanctions`, `reference_check`", "type": "string", "x-optional-for-reports": ["criminal_record", "sanctions", "reference_check"], "x-required-by-reports": ["sanctions", "news_search"]}, "phone": {"description": "Phone of the person to be checked.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "pipeline": {"allOf": [{"$ref": "#/components/schemas/PersonPipeline"}], "description": "Automatically enables reports and sets report_settings. It replaces `reports` and `report_settings` fields.", "x-optional-for-reports": [], "x-required-by-reports": []}, "report_settings": {"allOf": [{"$ref": "#/components/schemas/update_pa_definitions-ReportSettings"}], "description": "Custom report_settings setup by report manually.", "x-optional-for-reports": [], "x-required-by-reports": []}, "reports": {"allOf": [{"$ref": "#/components/schemas/update_pa_definitions-Reports"}], "description": "Custom report activation by enabling/disabling reports manually.", "x-optional-for-reports": [], "x-required-by-reports": []}, "surname": {"description": "Surname of the person to be checked. **Optional** for `criminal_record`", "type": "string", "x-optional-for-reports": ["criminal_record"], "x-required-by-reports": []}, "webhook_details": {"description": "If true, the webhook will include the report details in the response.", "type": "boolean", "x-optional-for-reports": [], "x-required-by-reports": []}, "webhook_headers": {"additionalProperties": {"type": "string"}, "description": "Webhook headers to send in the request to the webhook URL.", "type": "object", "x-optional-for-reports": [], "x-required-by-reports": []}, "webhook_url": {"description": "Webhook URL to receive notifications when this person has a folder finished.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}}, "title": "Update Panama Person Schema", "type": "object"}, "update_pe_definitions-ReportSettings": {"description": "Report settings schema by report.", "properties": {"dangerous_driver": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__pe__dangerous_driver__Settings"}], "description": "Report settings for dangerous_driver report.", "title": "Dangerous Driver"}, "drunk_driving": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__pe__drunk_driving__Settings"}], "description": "Report settings for drunk_driving report.", "title": "Drunk Driving"}, "labor_certificate": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__pe__labor_certificate__Settings"}], "description": "Report settings for labor_certificate report.", "title": "Labor Certificate"}, "license_status": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__pe__license_status__Settings"}], "description": "Report settings for license_status report.", "title": "License Status"}, "name_check": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__name_check__Settings"}], "description": "Report settings for name_check report.", "title": "Name Check"}, "news_search": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__news_search__Settings"}], "description": "Report settings for news search report.", "title": "News Search"}, "sanctions": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__sanctions__Settings"}], "description": "Sanctions Report Settings", "title": "Sanctions"}}, "title": "ReportSettings", "type": "object"}, "update_pe_definitions-Reports": {"description": "Available reports for Peru persons.", "properties": {"boletin_judicial": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks court journals (*Boletin Judicial*) from Peru Justice System (*Poder Judicial  del Per\u00fa*).", "title": "Boletin Judicial", "x-depends-on-reports": []}, "dangerous_driver": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Driver's License for Dangerous Driving fines.", "title": "Dangerous Driver", "x-depends-on-reports": []}, "dni_status": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Deprecated report. Please use `document_id_status` instead.", "title": "Dni Status", "x-depends-on-reports": []}, "document_id_status": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Document ID status.", "title": "Document Id Status", "x-depends-on-reports": []}, "drunk_driving": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Driver's License for Drunk Driving fines.", "title": "Drunk Driving", "x-depends-on-reports": []}, "foreigner_card_status": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Deprecated report. Please use `document_id_status` instead.", "title": "Foreigner Card Status", "x-depends-on-reports": []}, "justice_certificate": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Justice Certificate (*Certificado de Antecedentes Penales*).", "title": "Justice Certificate", "x-depends-on-reports": []}, "labor_certificate": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Labor Certificate (*Certificado \u00danico Laboral*).", "title": "Labor Certificate", "x-depends-on-reports": []}, "license_status": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Driver's License status.", "title": "License Status", "x-depends-on-reports": []}, "most_wanted": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Peruvian Most Wanted database.", "title": "Most Wanted", "x-depends-on-reports": []}, "name_check": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks `full_name` provided against `full_name` registered. **Depends On** details from the `document_id_status` report(s).", "title": "Name Check", "x-depends-on-reports": ["document_id_status"]}, "news_search": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks criminal and non-criminal information about a person.", "title": "News Search", "x-depends-on-reports": []}, "police_arrest": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks police news for arrests in the name of the person.", "title": "Police Arrest", "x-depends-on-reports": []}, "sanctions": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks sanctions reports from UN, OFAC, EEAS and World Bank.", "title": "Sanctions", "x-depends-on-reports": []}}, "title": "Reports", "type": "object"}, "update_pe": {"definitions": {"PersonPipeline": {"description": "Person pipeline details.", "properties": {"name": {"description": "Name of created pipeline.", "title": "Name", "type": "string"}}, "required": ["name"], "title": "Person Pipeline", "type": "object"}, "ReportEnable": {"description": "Enable or disable a report for a given person BGC.", "enum": ["enabled", "disabled"], "title": "ReportEnable", "type": "string"}, "ReportSettings": {"description": "Report settings schema by report.", "properties": {"dangerous_driver": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__pe__dangerous_driver__Settings"}], "description": "Report settings for dangerous_driver report.", "title": "Dangerous Driver"}, "drunk_driving": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__pe__drunk_driving__Settings"}], "description": "Report settings for drunk_driving report.", "title": "Drunk Driving"}, "labor_certificate": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__pe__labor_certificate__Settings"}], "description": "Report settings for labor_certificate report.", "title": "Labor Certificate"}, "license_status": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__pe__license_status__Settings"}], "description": "Report settings for license_status report.", "title": "License Status"}, "name_check": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__name_check__Settings"}], "description": "Report settings for name_check report.", "title": "Name Check"}, "news_search": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__news_search__Settings"}], "description": "Report settings for news search report.", "title": "News Search"}, "sanctions": {"allOf": [{"$ref": "#/components/schemas/bgcapi__schemas__report_settings__common__sanctions__Settings"}], "description": "Sanctions Report Settings", "title": "Sanctions"}}, "title": "ReportSettings", "type": "object"}, "Reports": {"description": "Available reports for Peru persons.", "properties": {"boletin_judicial": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks court journals (*Boletin Judicial*) from Peru Justice System (*Poder Judicial  del Per\u00fa*).", "title": "Boletin Judicial", "x-depends-on-reports": []}, "dangerous_driver": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Driver's License for Dangerous Driving fines.", "title": "Dangerous Driver", "x-depends-on-reports": []}, "dni_status": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Deprecated report. Please use `document_id_status` instead.", "title": "Dni Status", "x-depends-on-reports": []}, "document_id_status": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Document ID status.", "title": "Document Id Status", "x-depends-on-reports": []}, "drunk_driving": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Driver's License for Drunk Driving fines.", "title": "Drunk Driving", "x-depends-on-reports": []}, "foreigner_card_status": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Deprecated report. Please use `document_id_status` instead.", "title": "Foreigner Card Status", "x-depends-on-reports": []}, "justice_certificate": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Justice Certificate (*Certificado de Antecedentes Penales*).", "title": "Justice Certificate", "x-depends-on-reports": []}, "labor_certificate": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Labor Certificate (*Certificado \u00danico Laboral*).", "title": "Labor Certificate", "x-depends-on-reports": []}, "license_status": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Driver's License status.", "title": "License Status", "x-depends-on-reports": []}, "most_wanted": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks Peruvian Most Wanted database.", "title": "Most Wanted", "x-depends-on-reports": []}, "name_check": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks `full_name` provided against `full_name` registered. **Depends On** details from the `document_id_status` report(s).", "title": "Name Check", "x-depends-on-reports": ["document_id_status"]}, "news_search": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks criminal and non-criminal information about a person.", "title": "News Search", "x-depends-on-reports": []}, "police_arrest": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks police news for arrests in the name of the person.", "title": "Police Arrest", "x-depends-on-reports": []}, "sanctions": {"allOf": [{"$ref": "#/components/schemas/ReportEnable"}], "default": "disabled", "description": "Checks sanctions reports from UN, OFAC, EEAS and World Bank.", "title": "Sanctions", "x-depends-on-reports": []}}, "title": "Reports", "type": "object"}, "bgcapi__schemas__report_settings__common__name_check__Settings": {"description": "Report settings for name_check report.", "properties": {"name_fragment_check": {"default": false, "description": "If the report should check for name fragments instead of full name check.", "title": "Name Fragment Check", "type": "boolean"}, "name_score_min": {"default": 1, "description": "Minimum score for name match for a PASSED outcome (0.00 <= n <= 1.00).", "title": "Name Score Min", "type": "number"}}, "title": "Name Check Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__common__news_search__Settings": {"description": "Report settings for news_search report.", "properties": {"info_only": {"default": false, "description": "If set to true, the report outcome is always going to be set to INFO. Therefore it is not going to be considered in the person folder status calculation. However all details found are going to be visible through the report details endpoint.", "title": "Info Only", "type": "boolean"}}, "title": "Settings", "type": "object"}, "bgcapi__schemas__report_settings__common__sanctions__Settings": {"description": "Report settings for sanctions report.", "properties": {"name_score_min": {"default": 0.9, "description": "Minimum score for name match for a PASSED outcome (0.00 <= n <= 1.00).", "title": "Name Score Min", "type": "number"}, "show_ignored_records": {"default": false, "description": "Determine if ignored records are shown in the report details.", "title": "Show Ignored Records", "type": "boolean"}}, "title": "Sanctions Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__pe__dangerous_driver__Settings": {"description": "Report settings schema for dangerous_driver report.", "properties": {"not_found_action": {"default": "INCOMPLETE", "description": "Action that should be taken if license was `not_found`.", "enum": ["FAILED", "PASSED", "INCOMPLETE", "INFO"], "title": "Not Found Action", "type": "string"}}, "title": "PE Dangerous Driver Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__pe__drunk_driving__Settings": {"description": "Report settings schema for drunk_driving report.", "properties": {"not_found_action": {"default": "INCOMPLETE", "description": "Action that should be taken if license was `not_found`.", "enum": ["FAILED", "PASSED", "INCOMPLETE", "INFO"], "title": "Not Found Action", "type": "string"}}, "title": "PE Drunk Driving Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__pe__labor_certificate__Settings": {"description": "Report settings schema for labor_certificate report.", "properties": {"required_details": {"default": ["police_record_details", "judicial_record_details", "criminal_record_details"], "description": "List of `str` to be used to look at the `services_unavailable`.", "items": {"type": "string"}, "title": "Required Details", "type": "array"}}, "title": "PE Labor Certificate Report Settings", "type": "object"}, "bgcapi__schemas__report_settings__pe__license_status__Settings": {"description": "Report settings schema for license_status report.", "properties": {"not_found_action": {"default": "INCOMPLETE", "description": "Action that should be taken if license_status is `not_found`.", "enum": ["FAILED", "PASSED", "INCOMPLETE", "INFO"], "title": "Not Found Action", "type": "string"}}, "title": "PE License Status Report Settings", "type": "object"}}, "description": "Peru Person Schema.", "properties": {"city_locode": {"description": "2 letter country code and 3 letter location code for the city a person is located in. See the LOCODE reference.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "dob": {"description": "ISO 8601 representation of the date the person was born. **Optional** for `document_id_status`", "type": "string", "x-optional-for-reports": ["document_id_status"], "x-required-by-reports": []}, "document_id": {"description": "Document ID Number for Peru. **Required** for `license_status`, `drunk_driving`, `dangerous_driver`, `justice_certificate`, `labor_certificate`, `document_id_status` **Optional** for `name_check`, `reference_check`", "type": "string", "x-optional-for-reports": ["name_check", "reference_check"], "x-required-by-reports": ["license_status", "drunk_driving", "dangerous_driver", "justice_certificate", "labor_certificate", "document_id_status"]}, "document_id_alt": {"description": "Alternate Document ID Number.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "document_id_type": {"anyOf": [{"enum": ["foreigner_card", "national_id", "temporary_permit"], "type": "string"}, {"type": "string"}], "description": "Document ID type. **Required** for `license_status`, `drunk_driving`, `dangerous_driver`, `labor_certificate`, `document_id_status`", "x-optional-for-reports": [], "x-required-by-reports": ["license_status", "drunk_driving", "dangerous_driver", "labor_certificate", "document_id_status"]}, "drivers_license_id": {"description": "Driver's license ID number.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "forenames": {"description": "Forenames of the person to be checked. **Optional** for `most_wanted`, `police_arrest`", "type": "string", "x-optional-for-reports": ["most_wanted", "police_arrest"], "x-required-by-reports": []}, "full_name": {"description": "Full Name of the person to be checked. **Required** for `sanctions` **Optional** for `most_wanted`, `police_arrest`, `boletin_judicial`, `sanctions`, `name_check`, `news_search`, `reference_check`", "type": "string", "x-optional-for-reports": ["most_wanted", "police_arrest", "boletin_judicial", "sanctions", "name_check", "news_search", "reference_check"], "x-required-by-reports": ["sanctions"]}, "labor_certificate_id": {"description": "Certificate id number. **Required** for `labor_certificate`", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": ["labor_certificate"]}, "labor_certificate_type": {"description": "Certificate type. **Required** for `labor_certificate`", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": ["labor_certificate"]}, "phone": {"description": "Phone of the person to be checked.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "pipeline": {"allOf": [{"$ref": "#/components/schemas/PersonPipeline"}], "description": "Automatically enables reports and sets report_settings. It replaces `reports` and `report_settings` fields.", "x-optional-for-reports": [], "x-required-by-reports": []}, "report_settings": {"allOf": [{"$ref": "#/components/schemas/update_pe_definitions-ReportSettings"}], "description": "Custom report_settings setup by report manually.", "x-optional-for-reports": [], "x-required-by-reports": []}, "reports": {"allOf": [{"$ref": "#/components/schemas/update_pe_definitions-Reports"}], "description": "Custom report activation by enabling/disabling reports manually.", "x-optional-for-reports": [], "x-required-by-reports": []}, "request_code": {"description": "Request code. **Required** for `justice_certificate`", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": ["justice_certificate"]}, "ruc": {"description": "Company tax identification unique number in Peru.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}, "surname": {"description": "Surname of the person to be checked. **Optional** for `most_wanted`, `police_arrest`", "type": "string", "x-optional-for-reports": ["most_wanted", "police_arrest"], "x-required-by-reports": []}, "webhook_details": {"description": "If true, the webhook will include the report details in the response.", "type": "boolean", "x-optional-for-reports": [], "x-required-by-reports": []}, "webhook_headers": {"additionalProperties": {"type": "string"}, "description": "Webhook headers to send in the request to the webhook URL.", "type": "object", "x-optional-for-reports": [], "x-required-by-reports": []}, "webhook_url": {"description": "Webhook URL to receive notifications when this person has a folder finished.", "type": "string", "x-optional-for-reports": [], "x-required-by-reports": []}}, "title": "Update Peru Person Schema", "type": "object"}, "ManualReviewStatus": {"description": "Part of PersonStatusResponse.manual_review.", "properties": {"confirmed_homonym": {"description": "A positive result means the original name match was rejected after confirming another person with the same name.", "title": "Confirmed Homonym", "type": "boolean"}, "crime_category": {"description": "The category of the crime if found via manual review.", "title": "Crime Category", "type": "string"}, "excluded_process_type": {"description": "A positive result means the original process match was rejected after manually categorising the process.", "title": "Excluded Process Type", "type": "boolean"}, "observations": {"description": "Explains reason why a person was PASSED or FAILED.", "title": "Observations", "type": "string"}, "sentencing_status": {"description": "Current status of case reviewed.", "title": "Sentencing Status", "type": "string"}, "validation_comment": {"description": "Additional manual review information.", "title": "Validation Comment", "type": "string"}}, "title": "ManualReviewStatus", "type": "object"}, "ReportStatus": {"description": "Part of PersonStatusResponse.reports.", "properties": {"created_at": {"description": "ISO 8601 representation of the date when report started.", "title": "Created At", "type": "string"}, "outcome": {"description": "Only available if state is COMPLETED `(PASSED/FAILED)`", "title": "Outcome", "type": "string"}, "reviewed_at": {"description": "Timestamp of performed manual review if available, otherwise `null`.", "title": "Reviewed At", "type": "string"}, "state": {"description": "Keyword noting state of report `(PENDING/PENDING_MANUAL_REVIEW/COMPLETED/INCOMPLETE)`", "title": "State", "type": "string"}, "updated_at": {"description": "ISO 8601 representation of the date when report was done running.", "title": "Updated At", "type": "string"}}, "title": "ReportStatus", "type": "object"}, "Get_Person_Status": {"definitions": {"ManualReviewStatus": {"description": "Part of PersonStatusResponse.manual_review.", "properties": {"confirmed_homonym": {"description": "A positive result means the original name match was rejected after confirming another person with the same name.", "title": "Confirmed Homonym", "type": "boolean"}, "crime_category": {"description": "The category of the crime if found via manual review.", "title": "Crime Category", "type": "string"}, "excluded_process_type": {"description": "A positive result means the original process match was rejected after manually categorising the process.", "title": "Excluded Process Type", "type": "boolean"}, "observations": {"description": "Explains reason why a person was PASSED or FAILED.", "title": "Observations", "type": "string"}, "sentencing_status": {"description": "Current status of case reviewed.", "title": "Sentencing Status", "type": "string"}, "validation_comment": {"description": "Additional manual review information.", "title": "Validation Comment", "type": "string"}}, "title": "ManualReviewStatus", "type": "object"}, "ReportStatus": {"description": "Part of PersonStatusResponse.reports.", "properties": {"created_at": {"description": "ISO 8601 representation of the date when report started.", "title": "Created At", "type": "string"}, "outcome": {"description": "Only available if state is COMPLETED `(PASSED/FAILED)`", "title": "Outcome", "type": "string"}, "reviewed_at": {"description": "Timestamp of performed manual review if available, otherwise `null`.", "title": "Reviewed At", "type": "string"}, "state": {"description": "Keyword noting state of report `(PENDING/PENDING_MANUAL_REVIEW/COMPLETED/INCOMPLETE)`", "title": "State", "type": "string"}, "updated_at": {"description": "ISO 8601 representation of the date when report was done running.", "title": "Updated At", "type": "string"}}, "title": "ReportStatus", "type": "object"}}, "description": "Response for GET /<country>/persons/<person_id>/status endpoint.", "properties": {"created_at": {"description": "ISO 8601 representation of the date.", "title": "Created At", "type": "string"}, "custom_data": {"description": "Optional additional information provided when person was created.", "title": "Custom Data"}, "folder_id": {"description": "Latest Folder ID for this person.", "title": "Folder Id", "type": "string"}, "id": {"description": "Provided or generated id for the person being queried.", "title": "Id", "type": "string"}, "manual_review": {"allOf": [{"$ref": "#/components/schemas/ManualReviewStatus"}], "description": "Contains manual review observations, if it was manually reviewed.", "title": "Manual Review"}, "reports": {"additionalProperties": {"$ref": "#/components/schemas/ReportStatus"}, "description": "Object containing the reports enabled for this person.", "title": "Reports", "type": "object"}, "status": {"description": "Keyword noting state of report `(PENDING/PENDING_MANUAL_REVIEW/PASSED/FAILED/INCOMPLETE)`", "title": "Status", "type": "string"}, "updated_at": {"description": "ISO 8601 representation of the date all report reached end status.", "title": "Updated At", "type": "string"}}, "title": "Get Person Status", "type": "object"}, "Report": {"description": "Part of Get Reports endpoint.", "properties": {"state": {"description": "Keyword noting state of report `(PENDING/PENDING_MANUAL_REVIEW/COMPLETED/INCOMPLETE)`", "title": "State", "type": "string"}, "outcome": {"description": "Only available if state is COMPLETED `(PASSED/FAILED)`", "title": "Outcome", "type": "string"}, "created_at": {"description": "ISO 8601 representation of the date when report started.", "title": "Created At", "type": "string"}, "updated_at": {"description": "ISO 8601 representation of the date when report was done running.", "title": "Updated At", "type": "string"}}, "title": "Report", "type": "object"}, "Get_Reports_Response": {"definitions": {"Report": {"description": "Part of Get Reports endpoint.", "properties": {"state": {"description": "Keyword noting state of report `(PENDING/PENDING_MANUAL_REVIEW/COMPLETED/INCOMPLETE)`", "title": "State", "type": "string"}, "outcome": {"description": "Only available if state is COMPLETED `(PASSED/FAILED)`", "title": "Outcome", "type": "string"}, "created_at": {"description": "ISO 8601 representation of the date when report started.", "title": "Created At", "type": "string"}, "updated_at": {"description": "ISO 8601 representation of the date when report was done running.", "title": "Updated At", "type": "string"}}, "title": "Report", "type": "object"}}, "description": "Response for GET /<country>/reports/<person_id> endpoint.", "additionalProperties": {"$ref": "#/components/schemas/Report"}, "title": "Get All Reports", "type": "object"}, "ReportDetail": {"description": "Part of AllReportDetailsResponse.reports.", "properties": {"created_at": {"description": "ISO 8601 representation of the date when report started.", "title": "Created At", "type": "string"}, "details": {"description": "Report specific details found.", "title": "Details", "type": "object"}, "outcome": {"description": "Only available if state is COMPLETED `(PASSED/FAILED)`", "title": "Outcome", "type": "string"}, "state": {"description": "Keyword noting state of report `(PENDING/PENDING_MANUAL_REVIEW/COMPLETED/INCOMPLETE)`", "title": "State", "type": "string"}, "updated_at": {"description": "ISO 8601 representation of the date when report was done running.", "title": "Updated At", "type": "string"}}, "title": "ReportDetail", "type": "object"}, "Get_All_Report_Details": {"definitions": {"ReportDetail": {"description": "Part of AllReportDetailsResponse.reports.", "properties": {"created_at": {"description": "ISO 8601 representation of the date when report started.", "title": "Created At", "type": "string"}, "details": {"description": "Report specific details found.", "title": "Details", "type": "object"}, "outcome": {"description": "Only available if state is COMPLETED `(PASSED/FAILED)`", "title": "Outcome", "type": "string"}, "state": {"description": "Keyword noting state of report `(PENDING/PENDING_MANUAL_REVIEW/COMPLETED/INCOMPLETE)`", "title": "State", "type": "string"}, "updated_at": {"description": "ISO 8601 representation of the date when report was done running.", "title": "Updated At", "type": "string"}}, "title": "ReportDetail", "type": "object"}}, "description": "Response for GET /<country>/details/<person_id> endpoint.", "properties": {"id": {"description": "Provided or generated id for the person being queried.", "title": "Id", "type": "string"}, "reports": {"additionalProperties": {"$ref": "#/components/schemas/ReportDetail"}, "description": "Object containing the reports enabled for this person.", "title": "Reports", "type": "object"}}, "title": "Get All Report Details", "type": "object"}, "LicensesSchema": {"description": "Licenses schema.", "properties": {"type": {"title": "Type", "type": "string"}, "validity_end_date": {"title": "Validity End Date", "type": "string"}, "validity_start_date": {"title": "Validity Start Date", "type": "string"}}, "required": ["type", "validity_start_date", "validity_end_date"], "title": "License Status Details", "type": "object"}, "ec_license_status": {"definitions": {"LicensesSchema": {"description": "Licenses schema.", "properties": {"type": {"title": "Type", "type": "string"}, "validity_end_date": {"title": "Validity End Date", "type": "string"}, "validity_start_date": {"title": "Validity Start Date", "type": "string"}}, "required": ["type", "validity_start_date", "validity_end_date"], "title": "License Status Details", "type": "object"}}, "description": "Details schema for the license_status report.", "properties": {"document_id": {"title": "Document Id", "type": "string"}, "document_id_type": {"title": "Document Id Type", "type": "string"}, "full_name": {"title": "Full Name", "type": "string"}, "licenses": {"default": [], "items": {"$ref": "#/components/schemas/LicensesSchema"}, "title": "Licenses", "type": "array"}, "message": {"title": "Message", "type": "string"}, "points": {"default": 0, "title": "Points", "type": "number"}}, "title": "License Status Details", "type": "object"}, "FinesSchema": {"description": "Fines schema.", "properties": {"article": {"title": "Article", "type": "string"}, "article_description": {"title": "Article Description", "type": "string"}, "fine_amount": {"title": "Fine Amount", "type": "number"}, "full_article": {"title": "Full Article", "type": "string"}, "infraction": {"title": "Infraction", "type": "string"}, "infraction_number": {"title": "Infraction Number", "type": "string"}, "issued_at": {"title": "Issued At", "type": "string"}, "issuer": {"title": "Issuer", "type": "string"}, "license_plates": {"title": "License Plates", "type": "string"}, "points": {"title": "Points", "type": "number"}, "registered_at": {"title": "Registered At", "type": "string"}, "remission_amount": {"title": "Remission Amount", "type": "number"}, "sanction_amount": {"title": "Sanction Amount", "type": "number"}, "status": {"title": "Status", "type": "string"}, "total_amount": {"title": "Total Amount", "type": "string"}}, "required": ["article", "full_article", "article_description", "fine_amount", "infraction", "infraction_number", "issued_at", "issuer", "license_plates", "points", "registered_at", "remission_amount", "sanction_amount", "status", "total_amount"], "title": "Driving Record Details", "type": "object"}, "HistorySchema": {"description": "History schema.", "properties": {"balance": {"title": "Balance", "type": "string"}, "date": {"title": "Date", "type": "string"}, "observation": {"title": "Observation", "type": "string"}, "points": {"title": "Points", "type": "number"}, "previous_balance": {"title": "Previous Balance", "type": "string"}}, "required": ["balance", "date", "observation", "points", "previous_balance"], "title": "Driving Record Details", "type": "object"}, "definitions-LicensesSchema": {"description": "Licenses schema.", "properties": {"type": {"title": "Type", "type": "string"}, "validity_end_date": {"title": "Validity End Date", "type": "string"}, "validity_start_date": {"title": "Validity Start Date", "type": "string"}}, "required": ["type", "validity_start_date", "validity_end_date"], "title": "Driving Record Details", "type": "object"}, "ec_driving_record": {"definitions": {"FinesSchema": {"description": "Fines schema.", "properties": {"article": {"title": "Article", "type": "string"}, "article_description": {"title": "Article Description", "type": "string"}, "fine_amount": {"title": "Fine Amount", "type": "number"}, "full_article": {"title": "Full Article", "type": "string"}, "infraction": {"title": "Infraction", "type": "string"}, "infraction_number": {"title": "Infraction Number", "type": "string"}, "issued_at": {"title": "Issued At", "type": "string"}, "issuer": {"title": "Issuer", "type": "string"}, "license_plates": {"title": "License Plates", "type": "string"}, "points": {"title": "Points", "type": "number"}, "registered_at": {"title": "Registered At", "type": "string"}, "remission_amount": {"title": "Remission Amount", "type": "number"}, "sanction_amount": {"title": "Sanction Amount", "type": "number"}, "status": {"title": "Status", "type": "string"}, "total_amount": {"title": "Total Amount", "type": "string"}}, "required": ["article", "full_article", "article_description", "fine_amount", "infraction", "infraction_number", "issued_at", "issuer", "license_plates", "points", "registered_at", "remission_amount", "sanction_amount", "status", "total_amount"], "title": "Driving Record Details", "type": "object"}, "HistorySchema": {"description": "History schema.", "properties": {"balance": {"title": "Balance", "type": "string"}, "date": {"title": "Date", "type": "string"}, "observation": {"title": "Observation", "type": "string"}, "points": {"title": "Points", "type": "number"}, "previous_balance": {"title": "Previous Balance", "type": "string"}}, "required": ["balance", "date", "observation", "points", "previous_balance"], "title": "Driving Record Details", "type": "object"}, "LicensesSchema": {"description": "Licenses schema.", "properties": {"type": {"title": "Type", "type": "string"}, "validity_end_date": {"title": "Validity End Date", "type": "string"}, "validity_start_date": {"title": "Validity Start Date", "type": "string"}}, "required": ["type", "validity_start_date", "validity_end_date"], "title": "Driving Record Details", "type": "object"}}, "description": "Details schema for the name_check report.", "properties": {"document_id": {"title": "Document Id", "type": "string"}, "document_id_type": {"title": "Document Id Type", "type": "string"}, "fines": {"default": [], "items": {"$ref": "#/components/schemas/FinesSchema"}, "title": "Fines", "type": "array"}, "full_name": {"title": "Full Name", "type": "string"}, "history": {"default": [], "items": {"$ref": "#/components/schemas/HistorySchema"}, "title": "History", "type": "array"}, "licenses": {"default": [], "items": {"$ref": "#/components/schemas/definitions-LicensesSchema"}, "title": "Licenses", "type": "array"}, "message": {"title": "Message", "type": "string"}, "pending_remission": {"title": "Pending Remission", "type": "number"}, "pending_sanction": {"title": "Pending Sanction", "type": "number"}, "points": {"title": "Points", "type": "number"}, "settlement_amount": {"title": "Settlement Amount", "type": "number"}}, "title": "Driving Record Details", "type": "object"}, "MovementsSchema": {"description": "Parts schema.", "properties": {"date": {"title": "Date", "type": "string"}, "description": {"title": "Description", "type": "string"}, "title": {"title": "Title", "type": "string"}}, "required": ["date", "title", "description"], "title": "Justice Record Details", "type": "object"}, "PartsSchema": {"description": "Parts schema.", "properties": {"name": {"title": "Name", "type": "string"}, "role": {"title": "Role", "type": "string"}}, "required": ["name", "role"], "title": "Justice Record Details", "type": "object"}, "JusticeRecordItems": {"description": "Justice record items schema.", "properties": {"article": {"title": "Article", "type": "string"}, "court": {"title": "Court", "type": "string"}, "date": {"title": "Date", "type": "string"}, "movements": {"default": [], "items": {"$ref": "#/components/schemas/MovementsSchema"}, "title": "Movements", "type": "array"}, "parts": {"default": [], "items": {"$ref": "#/components/schemas/PartsSchema"}, "title": "Parts", "type": "array"}, "process_id": {"title": "Process Id", "type": "string"}, "process_type": {"title": "Process Type", "type": "string"}}, "required": ["process_id", "process_type", "article", "court", "date"], "title": "Justice Record Details", "type": "object"}, "ec_justice_record": {"definitions": {"JusticeRecordItems": {"description": "Justice record items schema.", "properties": {"article": {"title": "Article", "type": "string"}, "court": {"title": "Court", "type": "string"}, "date": {"title": "Date", "type": "string"}, "movements": {"default": [], "items": {"$ref": "#/components/schemas/MovementsSchema"}, "title": "Movements", "type": "array"}, "parts": {"default": [], "items": {"$ref": "#/components/schemas/PartsSchema"}, "title": "Parts", "type": "array"}, "process_id": {"title": "Process Id", "type": "string"}, "process_type": {"title": "Process Type", "type": "string"}}, "required": ["process_id", "process_type", "article", "court", "date"], "title": "Justice Record Details", "type": "object"}, "MovementsSchema": {"description": "Parts schema.", "properties": {"date": {"title": "Date", "type": "string"}, "description": {"title": "Description", "type": "string"}, "title": {"title": "Title", "type": "string"}}, "required": ["date", "title", "description"], "title": "Justice Record Details", "type": "object"}, "PartsSchema": {"description": "Parts schema.", "properties": {"name": {"title": "Name", "type": "string"}, "role": {"title": "Role", "type": "string"}}, "required": ["name", "role"], "title": "Justice Record Details", "type": "object"}}, "description": "Details schema for the Justice Record report.", "properties": {"items": {"items": {"$ref": "#/components/schemas/JusticeRecordItems"}, "title": "Items", "type": "array"}, "message": {"title": "Message", "type": "string"}}, "title": "Justice Record Details", "type": "object"}, "ec_cedula_details": {"description": "Information retrieved from check function.", "properties": {"dob": {"title": "Dob", "type": "string"}, "document_id": {"title": "Document Id", "type": "string"}, "full_name": {"title": "Full Name", "type": "string"}, "is_valid": {"title": "Is Valid", "type": "boolean"}, "message": {"title": "Message", "type": "string"}, "person_type": {"title": "Person Type", "type": "string"}}, "title": "Cedula Details Details", "type": "object"}, "Summary": {"description": "Summary schema for the news_search report.", "properties": {"relevant": {"description": "Whether the summary is relevant.", "title": "Relevant", "type": "boolean"}, "summary": {"description": "Summary of the news article.", "title": "Summary", "type": "string"}, "web_page_url": {"description": "URL of the news article.", "title": "Web Page Url", "type": "string"}}, "title": "News Search Details", "type": "object"}, "ec_news_search": {"definitions": {"Summary": {"description": "Summary schema for the news_search report.", "properties": {"relevant": {"description": "Whether the summary is relevant.", "title": "Relevant", "type": "boolean"}, "summary": {"description": "Summary of the news article.", "title": "Summary", "type": "string"}, "web_page_url": {"description": "URL of the news article.", "title": "Web Page Url", "type": "string"}}, "title": "News Search Details", "type": "object"}}, "description": "Details schema for the news_search report.", "properties": {"full_name": {"description": "Query used to search for the person.", "title": "Full Name", "type": "string"}, "message": {"title": "Message", "type": "string"}, "summaries": {"description": "List of AI generated summaries.", "items": {"$ref": "#/components/schemas/Summary"}, "title": "Summaries", "type": "array"}}, "title": "News Search Details", "type": "object"}, "ec_sanctions": {"description": "Sanctions details schema.", "properties": {"found_matches": {"default": false, "title": "Found Matches", "type": "boolean"}, "ignored_items": {"items": {"type": "object"}, "title": "Ignored Items", "type": "array"}, "matches": {"additionalProperties": {"items": {"type": "object"}, "type": "array"}, "title": "Matches", "type": "object"}, "message": {"title": "Message", "type": "string"}}, "title": "Sanctions Details", "type": "object"}, "ec_name_check": {"description": "Details schema for the name_check report.", "properties": {"full_name": {"title": "Full Name", "type": "string"}, "message": {"title": "Message", "type": "string"}, "name_fragment_check": {"title": "Name Fragment Check", "type": "boolean"}, "name_score_min": {"title": "Name Score Min", "type": "number"}, "score": {"title": "Score", "type": "number"}}, "required": ["score", "full_name", "name_fragment_check", "name_score_min"], "title": "Name Check Details", "type": "object"}, "ec_one_of": {"oneOf": [{"$ref": "#/components/schemas/ec_license_status"}, {"$ref": "#/components/schemas/ec_driving_record"}, {"$ref": "#/components/schemas/ec_justice_record"}, {"$ref": "#/components/schemas/ec_cedula_details"}, {"$ref": "#/components/schemas/ec_news_search"}, {"$ref": "#/components/schemas/ec_sanctions"}, {"$ref": "#/components/schemas/ec_name_check"}]}, "pa_cedula_details": {"description": "Generic Details schema.", "properties": {"message": {"title": "Message", "type": "string"}}, "title": "Cedula Details Details", "type": "object"}, "ResultItem": {"description": "Schema of result items.", "properties": {"date": {"title": "Date", "type": "string"}, "page": {"title": "Page", "type": "string"}, "url": {"title": "Url", "type": "string"}}, "title": "Criminal Record Details", "type": "object"}, "pa_criminal_record": {"definitions": {"ResultItem": {"description": "Schema of result items.", "properties": {"date": {"title": "Date", "type": "string"}, "page": {"title": "Page", "type": "string"}, "url": {"title": "Url", "type": "string"}}, "title": "Criminal Record Details", "type": "object"}}, "description": "Details schema for criminal record report.", "properties": {"audience_calendar": {"items": {"$ref": "#/components/schemas/ResultItem"}, "title": "Audience Calendar", "type": "array"}, "judicial_news": {"items": {"$ref": "#/components/schemas/ResultItem"}, "title": "Judicial News", "type": "array"}, "judicial_record": {"items": {"$ref": "#/components/schemas/ResultItem"}, "title": "Judicial Record", "type": "array"}, "message": {"title": "Message", "type": "string"}}, "title": "Criminal Record Details", "type": "object"}, "pa_license_status": {"description": "Details schema for license status report.", "properties": {"full_name": {"title": "Full Name", "type": "string"}, "message": {"title": "Message", "type": "string"}, "points": {"title": "Points", "type": "string"}}, "title": "License Status Details", "type": "object"}, "pa_drunk_driving": {"description": "Details schema for drunk driving report.", "properties": {"matched_tickets": {"items": {"type": "string"}, "title": "Matched Tickets", "type": "array"}, "message": {"title": "Message", "type": "string"}}, "title": "Drunk Driving Details", "type": "object"}, "pa_sanctions": {"description": "Sanctions details schema.", "properties": {"found_matches": {"default": false, "title": "Found Matches", "type": "boolean"}, "ignored_items": {"items": {"type": "object"}, "title": "Ignored Items", "type": "array"}, "matches": {"additionalProperties": {"items": {"type": "object"}, "type": "array"}, "title": "Matches", "type": "object"}, "message": {"title": "Message", "type": "string"}}, "title": "Sanctions Details", "type": "object"}, "pa_news_search": {"definitions": {"Summary": {"description": "Summary schema for the news_search report.", "properties": {"relevant": {"description": "Whether the summary is relevant.", "title": "Relevant", "type": "boolean"}, "summary": {"description": "Summary of the news article.", "title": "Summary", "type": "string"}, "web_page_url": {"description": "URL of the news article.", "title": "Web Page Url", "type": "string"}}, "title": "News Search Details", "type": "object"}}, "description": "Details schema for the news_search report.", "properties": {"full_name": {"description": "Query used to search for the person.", "title": "Full Name", "type": "string"}, "message": {"title": "Message", "type": "string"}, "summaries": {"description": "List of AI generated summaries.", "items": {"$ref": "#/components/schemas/Summary"}, "title": "Summaries", "type": "array"}}, "title": "News Search Details", "type": "object"}, "pa_one_of": {"oneOf": [{"$ref": "#/components/schemas/pa_cedula_details"}, {"$ref": "#/components/schemas/pa_criminal_record"}, {"$ref": "#/components/schemas/pa_license_status"}, {"$ref": "#/components/schemas/pa_drunk_driving"}, {"$ref": "#/components/schemas/pa_sanctions"}, {"$ref": "#/components/schemas/pa_news_search"}]}, "co_license_status": {"description": "Details schema for the license_status report.", "properties": {"active": {"title": "Active", "type": "boolean"}, "full_name": {"title": "Full Name", "type": "string"}, "license_codes": {"items": {"type": "string"}, "title": "License Codes", "type": "array"}, "message": {"title": "Message", "type": "string"}}, "title": "License Status Details", "type": "object"}, "co_drunk_driving": {"description": "Details schema for SIMIT information.", "properties": {"active_subpoena_amount": {"title": "Active Subpoena Amount", "type": "integer"}, "active_subpoena_owed": {"title": "Active Subpoena Owed", "type": "integer"}, "document": {"title": "Document", "type": "string"}, "drunk_driver": {"title": "Drunk Driver", "type": "boolean"}, "message": {"title": "Message", "type": "string"}, "pending": {"title": "Pending", "type": "integer"}, "total_owed": {"title": "Total Owed", "type": "integer"}, "valid_license": {"title": "Valid License", "type": "boolean"}}, "title": "Drunk Driving Details", "type": "object"}, "co_fine_debt": {"description": "Details schema for SIMIT information.", "properties": {"active_subpoena_amount": {"title": "Active Subpoena Amount", "type": "integer"}, "active_subpoena_owed": {"title": "Active Subpoena Owed", "type": "integer"}, "document": {"title": "Document", "type": "string"}, "drunk_driver": {"title": "Drunk Driver", "type": "boolean"}, "message": {"title": "Message", "type": "string"}, "pending": {"title": "Pending", "type": "integer"}, "total_owed": {"title": "Total Owed", "type": "integer"}, "valid_license": {"title": "Valid License", "type": "boolean"}}, "title": "Fine Debt Details", "type": "object"}, "co_fine_count": {"description": "Details schema for SIMIT information.", "properties": {"active_subpoena_amount": {"title": "Active Subpoena Amount", "type": "integer"}, "active_subpoena_owed": {"title": "Active Subpoena Owed", "type": "integer"}, "document": {"title": "Document", "type": "string"}, "drunk_driver": {"title": "Drunk Driver", "type": "boolean"}, "message": {"title": "Message", "type": "string"}, "pending": {"title": "Pending", "type": "integer"}, "total_owed": {"title": "Total Owed", "type": "integer"}, "valid_license": {"title": "Valid License", "type": "boolean"}}, "title": "Fine Count Details", "type": "object"}, "ConvictListSchema": {"description": "Convict List Schema.", "properties": {"criminal_name": {"title": "Criminal Name", "type": "string"}, "document_id": {"title": "Document Id", "type": "string"}}, "title": "Justice Record Details", "type": "object"}, "CrimesSchema": {"description": "crimes schema.", "properties": {"city": {"title": "City", "type": "string"}, "convict_list": {"default": [], "items": {"$ref": "#/components/schemas/ConvictListSchema"}, "title": "Convict List", "type": "array"}, "crime": {"title": "Crime", "type": "string"}, "crime_category": {"title": "Crime Category", "type": "string"}, "crime_date": {"title": "Crime Date", "type": "string"}, "crime_is_ignored": {"title": "Crime Is Ignored", "type": "boolean"}, "crime_keyword": {"title": "Crime Keyword", "type": "string"}, "document_id": {"title": "Document Id", "type": "string"}, "process_class_data": {"default": [], "items": {"type": "string"}, "title": "Process Class Data", "type": "array"}, "process_type": {"title": "Process Type", "type": "string"}, "url": {"title": "Url", "type": "string"}}, "title": "Justice Record Details", "type": "object"}, "co_justice_record": {"definitions": {"ConvictListSchema": {"description": "Convict List Schema.", "properties": {"criminal_name": {"title": "Criminal Name", "type": "string"}, "document_id": {"title": "Document Id", "type": "string"}}, "title": "Justice Record Details", "type": "object"}, "CrimesSchema": {"description": "crimes schema.", "properties": {"city": {"title": "City", "type": "string"}, "convict_list": {"default": [], "items": {"$ref": "#/components/schemas/ConvictListSchema"}, "title": "Convict List", "type": "array"}, "crime": {"title": "Crime", "type": "string"}, "crime_category": {"title": "Crime Category", "type": "string"}, "crime_date": {"title": "Crime Date", "type": "string"}, "crime_is_ignored": {"title": "Crime Is Ignored", "type": "boolean"}, "crime_keyword": {"title": "Crime Keyword", "type": "string"}, "document_id": {"title": "Document Id", "type": "string"}, "process_class_data": {"default": [], "items": {"type": "string"}, "title": "Process Class Data", "type": "array"}, "process_type": {"title": "Process Type", "type": "string"}, "url": {"title": "Url", "type": "string"}}, "title": "Justice Record Details", "type": "object"}}, "description": "Details schema for the justice records report.", "properties": {"cities": {"default": [], "items": {"type": "string"}, "title": "Cities", "type": "array"}, "crimes": {"default": [], "items": {"$ref": "#/components/schemas/CrimesSchema"}, "title": "Crimes", "type": "array"}, "main_crime_category": {"title": "Main Crime Category", "type": "string"}, "main_crime_keyword": {"title": "Main Crime Keyword", "type": "string"}, "message": {"title": "Message", "type": "string"}}, "title": "Justice Record Details", "type": "object"}, "co_police_record": {"description": "Details schema for the police records report.", "properties": {"document": {"title": "Document", "type": "string"}, "full_name": {"title": "Full Name", "type": "string"}, "has_record": {"title": "Has Record", "type": "boolean"}, "legal_definition_en": {"title": "Legal Definition En", "type": "string"}, "legal_definition_es": {"title": "Legal Definition Es", "type": "string"}, "message": {"title": "Message", "type": "string"}, "status_message": {"title": "Status Message", "type": "string"}}, "title": "Police Record Details", "type": "object"}, "co_procuradoria_record": {"description": "Procuradoria Record details.", "properties": {"criminal_records": {"items": {"type": "object"}, "title": "Criminal Records", "type": "array"}, "disqualifications": {"items": {"type": "object"}, "title": "Disqualifications", "type": "array"}, "document": {"title": "Document", "type": "string"}, "forenames": {"title": "Forenames", "type": "string"}, "full_name": {"title": "Full Name", "type": "string"}, "has_record": {"title": "Has Record", "type": "boolean"}, "message": {"title": "Message", "type": "string"}, "not_found": {"title": "Not Found", "type": "boolean"}, "surnames": {"title": "Surnames", "type": "string"}}, "title": "Procuradoria Record Details", "type": "object"}, "ApplicationItem": {"description": "Application item schema.", "properties": {"application_date": {"title": "Application Date", "type": "string"}, "application_id": {"title": "Application Id", "type": "string"}, "entity": {"title": "Entity", "type": "string"}, "process": {"title": "Process", "type": "string"}, "status": {"title": "Status", "type": "string"}}, "title": "Vehicle Check Details", "type": "object"}, "GeneralInformationSchema": {"description": "General information schema.", "properties": {"antique": {"title": "Antique", "type": "string"}, "bodywork_type": {"title": "Bodywork Type", "type": "string"}, "brand": {"title": "Brand", "type": "string"}, "chassis": {"title": "Chassis", "type": "string"}, "chassis_rerecording": {"title": "Chassis Rerecording", "type": "string"}, "color": {"title": "Color", "type": "string"}, "cylinder_capacity": {"title": "Cylinder Capacity", "type": "string"}, "doors": {"title": "Doors", "type": "string"}, "fuel_type": {"title": "Fuel Type", "type": "string"}, "initial_registry_date": {"title": "Initial Registry Date", "type": "string"}, "learning_vehicle": {"title": "Learning Vehicle", "type": "string"}, "line": {"title": "Line", "type": "string"}, "message": {"title": "Message", "type": "string"}, "model": {"title": "Model", "type": "string"}, "motor_number": {"title": "Motor Number", "type": "string"}, "motor_rerecording": {"title": "Motor Rerecording", "type": "string"}, "property_liens": {"title": "Property Liens", "type": "string"}, "serial_number": {"title": "Serial Number", "type": "string"}, "serial_rerecording": {"title": "Serial Rerecording", "type": "string"}, "traffic_authority": {"title": "Traffic Authority", "type": "string"}, "upgraded": {"title": "Upgraded", "type": "string"}, "vin_number": {"title": "Vin Number", "type": "string"}, "vin_rerecording": {"title": "Vin Rerecording", "type": "string"}}, "title": "Vehicle Check Details", "type": "object"}, "RtmItem": {"description": "RTM item schema.", "properties": {"certificate_id": {"title": "Certificate Id", "type": "string"}, "consistent_information": {"title": "Consistent Information", "type": "string"}, "due_date": {"title": "Due Date", "type": "string"}, "inspection_type": {"title": "Inspection Type", "type": "string"}, "issue_date": {"title": "Issue Date", "type": "string"}, "issuing_cda": {"title": "Issuing Cda", "type": "string"}, "plate": {"title": "Plate", "type": "string"}, "url": {"title": "Url", "type": "string"}, "valid": {"title": "Valid", "type": "string"}}, "title": "Vehicle Check Details", "type": "object"}, "SoatPolicyItem": {"description": "Soat policy item schema.", "properties": {"due_date": {"title": "Due Date", "type": "string"}, "issue_date": {"title": "Issue Date", "type": "string"}, "issuing_entity": {"title": "Issuing Entity", "type": "string"}, "policy_number": {"title": "Policy Number", "type": "string"}, "policy_status": {"title": "Policy Status", "type": "string"}, "start_date": {"title": "Start Date", "type": "string"}}, "title": "Vehicle Check Details", "type": "object"}, "TechnicalInformationSchema": {"description": "Technical information schema.", "properties": {"axel_number": {"title": "Axel Number", "type": "string"}, "carry_capacity": {"title": "Carry Capacity", "type": "string"}, "passenger_capacity": {"title": "Passenger Capacity", "type": "string"}, "sited_passenger_capacity": {"title": "Sited Passenger Capacity", "type": "string"}, "vehicle_gross_weight": {"title": "Vehicle Gross Weight", "type": "string"}}, "title": "Vehicle Check Details", "type": "object"}, "co_vehicle_check": {"definitions": {"ApplicationItem": {"description": "Application item schema.", "properties": {"application_date": {"title": "Application Date", "type": "string"}, "application_id": {"title": "Application Id", "type": "string"}, "entity": {"title": "Entity", "type": "string"}, "process": {"title": "Process", "type": "string"}, "status": {"title": "Status", "type": "string"}}, "title": "Vehicle Check Details", "type": "object"}, "GeneralInformationSchema": {"description": "General information schema.", "properties": {"antique": {"title": "Antique", "type": "string"}, "bodywork_type": {"title": "Bodywork Type", "type": "string"}, "brand": {"title": "Brand", "type": "string"}, "chassis": {"title": "Chassis", "type": "string"}, "chassis_rerecording": {"title": "Chassis Rerecording", "type": "string"}, "color": {"title": "Color", "type": "string"}, "cylinder_capacity": {"title": "Cylinder Capacity", "type": "string"}, "doors": {"title": "Doors", "type": "string"}, "fuel_type": {"title": "Fuel Type", "type": "string"}, "initial_registry_date": {"title": "Initial Registry Date", "type": "string"}, "learning_vehicle": {"title": "Learning Vehicle", "type": "string"}, "line": {"title": "Line", "type": "string"}, "message": {"title": "Message", "type": "string"}, "model": {"title": "Model", "type": "string"}, "motor_number": {"title": "Motor Number", "type": "string"}, "motor_rerecording": {"title": "Motor Rerecording", "type": "string"}, "property_liens": {"title": "Property Liens", "type": "string"}, "serial_number": {"title": "Serial Number", "type": "string"}, "serial_rerecording": {"title": "Serial Rerecording", "type": "string"}, "traffic_authority": {"title": "Traffic Authority", "type": "string"}, "upgraded": {"title": "Upgraded", "type": "string"}, "vin_number": {"title": "Vin Number", "type": "string"}, "vin_rerecording": {"title": "Vin Rerecording", "type": "string"}}, "title": "Vehicle Check Details", "type": "object"}, "RtmItem": {"description": "RTM item schema.", "properties": {"certificate_id": {"title": "Certificate Id", "type": "string"}, "consistent_information": {"title": "Consistent Information", "type": "string"}, "due_date": {"title": "Due Date", "type": "string"}, "inspection_type": {"title": "Inspection Type", "type": "string"}, "issue_date": {"title": "Issue Date", "type": "string"}, "issuing_cda": {"title": "Issuing Cda", "type": "string"}, "plate": {"title": "Plate", "type": "string"}, "url": {"title": "Url", "type": "string"}, "valid": {"title": "Valid", "type": "string"}}, "title": "Vehicle Check Details", "type": "object"}, "SoatPolicyItem": {"description": "Soat policy item schema.", "properties": {"due_date": {"title": "Due Date", "type": "string"}, "issue_date": {"title": "Issue Date", "type": "string"}, "issuing_entity": {"title": "Issuing Entity", "type": "string"}, "policy_number": {"title": "Policy Number", "type": "string"}, "policy_status": {"title": "Policy Status", "type": "string"}, "start_date": {"title": "Start Date", "type": "string"}}, "title": "Vehicle Check Details", "type": "object"}, "TechnicalInformationSchema": {"description": "Technical information schema.", "properties": {"axel_number": {"title": "Axel Number", "type": "string"}, "carry_capacity": {"title": "Carry Capacity", "type": "string"}, "passenger_capacity": {"title": "Passenger Capacity", "type": "string"}, "sited_passenger_capacity": {"title": "Sited Passenger Capacity", "type": "string"}, "vehicle_gross_weight": {"title": "Vehicle Gross Weight", "type": "string"}}, "title": "Vehicle Check Details", "type": "object"}}, "description": "Vehicle Check details schema.", "properties": {"ambiental_teaching_inspection": {"items": {"type": "object"}, "title": "Ambiental Teaching Inspection", "type": "array"}, "application": {"items": {"$ref": "#/components/schemas/ApplicationItem"}, "title": "Application", "type": "array"}, "armor_plating": {"title": "Armor Plating", "type": "object"}, "cargo_vehicle_initial_authorization": {"title": "Cargo Vehicle Initial Authorization", "type": "object"}, "circulation_permit_restriction": {"items": {"type": "object"}, "title": "Circulation Permit Restriction", "type": "array"}, "civil_responsability_policy": {"items": {"type": "object"}, "title": "Civil Responsability Policy", "type": "array"}, "dijin_inpsection_certificate": {"title": "Dijin Inpsection Certificate", "type": "object"}, "driver_license": {"title": "Driver License", "type": "string"}, "general_information": {"$ref": "#/components/schemas/GeneralInformationSchema"}, "invc_cargo_vehicle_initial_authorization": {"title": "Invc Cargo Vehicle Initial Authorization", "type": "object"}, "license_plate": {"title": "License Plate", "type": "string"}, "message": {"title": "Message", "type": "string"}, "normalization_sanitation": {"items": {"type": "object"}, "title": "Normalization Sanitation", "type": "array"}, "operation_card": {"title": "Operation Card", "type": "object"}, "physical_removal_agreement_surety_policy": {"title": "Physical Removal Agreement Surety Policy", "type": "object"}, "physical_removal_certificate": {"title": "Physical Removal Certificate", "type": "object"}, "property_limitations": {"items": {"type": "object"}, "title": "Property Limitations", "type": "array"}, "rngm_surety": {"items": {"type": "object"}, "title": "Rngm Surety", "type": "array"}, "rtm": {"items": {"$ref": "#/components/schemas/RtmItem"}, "title": "Rtm", "type": "array"}, "service_type": {"title": "Service Type", "type": "string"}, "soat_policy": {"items": {"$ref": "#/components/schemas/SoatPolicyItem"}, "title": "Soat Policy", "type": "array"}, "surety": {"items": {"type": "object"}, "title": "Surety", "type": "array"}, "technical_information": {"$ref": "#/components/schemas/TechnicalInformationSchema"}, "vehicle_class": {"title": "Vehicle Class", "type": "string"}, "vehicle_removal_due_to_normalization": {"items": {"type": "object"}, "title": "Vehicle Removal Due To Normalization", "type": "array"}, "vehicle_status": {"title": "Vehicle Status", "type": "string"}}, "title": "Vehicle Check Details", "type": "object"}, "co_sanctions": {"description": "Sanctions details schema.", "properties": {"found_matches": {"default": false, "title": "Found Matches", "type": "boolean"}, "ignored_items": {"items": {"type": "object"}, "title": "Ignored Items", "type": "array"}, "matches": {"additionalProperties": {"items": {"type": "object"}, "type": "array"}, "title": "Matches", "type": "object"}, "message": {"title": "Message", "type": "string"}}, "title": "Sanctions Details", "type": "object"}, "co_name_check": {"description": "Details schema for the name_check report.", "properties": {"full_name": {"title": "Full Name", "type": "string"}, "message": {"title": "Message", "type": "string"}, "name_fragment_check": {"title": "Name Fragment Check", "type": "boolean"}, "name_score_min": {"title": "Name Score Min", "type": "number"}, "score": {"title": "Score", "type": "number"}}, "required": ["score", "full_name", "name_fragment_check", "name_score_min"], "title": "Name Check Details", "type": "object"}, "PersonInfoProcessPart": {"description": "Found in `details.person_informations.process_parts`.", "properties": {"part": {"title": "Part", "type": "string"}, "type": {"title": "Type", "type": "string"}}, "title": "Process Search Details", "type": "object"}, "PersonInfo": {"description": "Person information found in `details.person_informations`.", "properties": {"court_department": {"title": "Court Department", "type": "string"}, "entry_date": {"title": "Entry Date", "type": "string"}, "last_movement": {"title": "Last Movement", "type": "string"}, "process_id": {"title": "Process Id", "type": "string"}, "process_parts": {"items": {"$ref": "#/components/schemas/PersonInfoProcessPart"}, "title": "Process Parts", "type": "array"}}, "title": "Process Search Details", "type": "object"}, "ProcessData": {"description": "Found in `details.process_data`.", "properties": {"appeal": {"title": "Appeal", "type": "string"}, "court": {"title": "Court", "type": "string"}, "entry_date": {"title": "Entry Date", "type": "string"}, "file_location": {"title": "File Location", "type": "string"}, "judge": {"title": "Judge", "type": "string"}, "process_class": {"title": "Process Class", "type": "string"}, "process_subclass": {"title": "Process Subclass", "type": "string"}, "process_subject": {"title": "Process Subject", "type": "string"}, "process_type": {"title": "Process Type", "type": "string"}}, "title": "Process Search Details", "type": "object"}, "ProcessDocument": {"description": "Element of `details.process_documents`.", "properties": {"description": {"title": "Description", "type": "string"}, "download": {"title": "Download", "type": "string"}, "name": {"title": "Name", "type": "string"}}, "title": "Process Search Details", "type": "object"}, "ProcessMovement": {"description": "Element of `details.process_movements`.", "properties": {"annotation": {"title": "Annotation", "type": "string"}, "end_date": {"title": "End Date", "type": "string"}, "movement": {"title": "Movement", "type": "string"}, "movement_date": {"title": "Movement Date", "type": "string"}, "registration_date": {"title": "Registration Date", "type": "string"}, "start_date": {"title": "Start Date", "type": "string"}}, "title": "Process Search Details", "type": "object"}, "ProcessPart": {"description": "Element of `details.process_parts`.", "properties": {"name_score": {"title": "Name Score", "type": "number"}, "natural_or_legal_person": {"title": "Natural Or Legal Person", "type": "string"}, "type": {"title": "Type", "type": "string"}}, "title": "Process Search Details", "type": "object"}, "ItemDetails": {"description": "Result item details.", "properties": {"person_informations": {"$ref": "#/components/schemas/PersonInfo"}, "process_data": {"$ref": "#/components/schemas/ProcessData"}, "process_documents": {"items": {"$ref": "#/components/schemas/ProcessDocument"}, "title": "Process Documents", "type": "array"}, "process_movements": {"items": {"$ref": "#/components/schemas/ProcessMovement"}, "title": "Process Movements", "type": "array"}, "process_parts": {"items": {"$ref": "#/components/schemas/ProcessPart"}, "title": "Process Parts", "type": "array"}}, "title": "Process Search Details", "type": "object"}, "Item": {"description": "Element of `items`.", "properties": {"details": {"$ref": "#/components/schemas/ItemDetails"}, "ignored_reasons": {"items": {"type": "string"}, "title": "Ignored Reasons", "type": "array"}}, "title": "Process Search Details", "type": "object"}, "co_process_search": {"definitions": {"Item": {"description": "Element of `items`.", "properties": {"details": {"$ref": "#/components/schemas/ItemDetails"}, "ignored_reasons": {"items": {"type": "string"}, "title": "Ignored Reasons", "type": "array"}}, "title": "Process Search Details", "type": "object"}, "ItemDetails": {"description": "Result item details.", "properties": {"person_informations": {"$ref": "#/components/schemas/PersonInfo"}, "process_data": {"$ref": "#/components/schemas/ProcessData"}, "process_documents": {"items": {"$ref": "#/components/schemas/ProcessDocument"}, "title": "Process Documents", "type": "array"}, "process_movements": {"items": {"$ref": "#/components/schemas/ProcessMovement"}, "title": "Process Movements", "type": "array"}, "process_parts": {"items": {"$ref": "#/components/schemas/ProcessPart"}, "title": "Process Parts", "type": "array"}}, "title": "Process Search Details", "type": "object"}, "PersonInfo": {"description": "Person information found in `details.person_informations`.", "properties": {"court_department": {"title": "Court Department", "type": "string"}, "entry_date": {"title": "Entry Date", "type": "string"}, "last_movement": {"title": "Last Movement", "type": "string"}, "process_id": {"title": "Process Id", "type": "string"}, "process_parts": {"items": {"$ref": "#/components/schemas/PersonInfoProcessPart"}, "title": "Process Parts", "type": "array"}}, "title": "Process Search Details", "type": "object"}, "PersonInfoProcessPart": {"description": "Found in `details.person_informations.process_parts`.", "properties": {"part": {"title": "Part", "type": "string"}, "type": {"title": "Type", "type": "string"}}, "title": "Process Search Details", "type": "object"}, "ProcessData": {"description": "Found in `details.process_data`.", "properties": {"appeal": {"title": "Appeal", "type": "string"}, "court": {"title": "Court", "type": "string"}, "entry_date": {"title": "Entry Date", "type": "string"}, "file_location": {"title": "File Location", "type": "string"}, "judge": {"title": "Judge", "type": "string"}, "process_class": {"title": "Process Class", "type": "string"}, "process_subclass": {"title": "Process Subclass", "type": "string"}, "process_subject": {"title": "Process Subject", "type": "string"}, "process_type": {"title": "Process Type", "type": "string"}}, "title": "Process Search Details", "type": "object"}, "ProcessDocument": {"description": "Element of `details.process_documents`.", "properties": {"description": {"title": "Description", "type": "string"}, "download": {"title": "Download", "type": "string"}, "name": {"title": "Name", "type": "string"}}, "title": "Process Search Details", "type": "object"}, "ProcessMovement": {"description": "Element of `details.process_movements`.", "properties": {"annotation": {"title": "Annotation", "type": "string"}, "end_date": {"title": "End Date", "type": "string"}, "movement": {"title": "Movement", "type": "string"}, "movement_date": {"title": "Movement Date", "type": "string"}, "registration_date": {"title": "Registration Date", "type": "string"}, "start_date": {"title": "Start Date", "type": "string"}}, "title": "Process Search Details", "type": "object"}, "ProcessPart": {"description": "Element of `details.process_parts`.", "properties": {"name_score": {"title": "Name Score", "type": "number"}, "natural_or_legal_person": {"title": "Natural Or Legal Person", "type": "string"}, "type": {"title": "Type", "type": "string"}}, "title": "Process Search Details", "type": "object"}}, "description": "Results found and ignored.", "properties": {"ignored_items": {"items": {"$ref": "#/components/schemas/Item"}, "title": "Ignored Items", "type": "array"}, "items": {"items": {"$ref": "#/components/schemas/Item"}, "title": "Items", "type": "array"}}, "title": "Process Search Details", "type": "object"}, "co_news_search": {"definitions": {"Summary": {"description": "Summary schema for the news_search report.", "properties": {"relevant": {"description": "Whether the summary is relevant.", "title": "Relevant", "type": "boolean"}, "summary": {"description": "Summary of the news article.", "title": "Summary", "type": "string"}, "web_page_url": {"description": "URL of the news article.", "title": "Web Page Url", "type": "string"}}, "title": "News Search Details", "type": "object"}}, "description": "Details schema for the news_search report.", "properties": {"full_name": {"description": "Query used to search for the person.", "title": "Full Name", "type": "string"}, "message": {"title": "Message", "type": "string"}, "summaries": {"description": "List of AI generated summaries.", "items": {"$ref": "#/components/schemas/Summary"}, "title": "Summaries", "type": "array"}}, "title": "News Search Details", "type": "object"}, "co_one_of": {"oneOf": [{"$ref": "#/components/schemas/co_license_status"}, {"$ref": "#/components/schemas/co_drunk_driving"}, {"$ref": "#/components/schemas/co_fine_debt"}, {"$ref": "#/components/schemas/co_fine_count"}, {"$ref": "#/components/schemas/co_justice_record"}, {"$ref": "#/components/schemas/co_police_record"}, {"$ref": "#/components/schemas/co_procuradoria_record"}, {"$ref": "#/components/schemas/co_vehicle_check"}, {"$ref": "#/components/schemas/co_sanctions"}, {"$ref": "#/components/schemas/co_name_check"}, {"$ref": "#/components/schemas/co_process_search"}, {"$ref": "#/components/schemas/co_news_search"}]}, "BestMatchSchema": {"description": "Schema of the details obtained from the matching.", "properties": {"abstract": {"title": "Sintesis", "type": "string"}, "authority": {"title": "Autoridad", "type": "string"}, "court_id": {"title": "Court Id", "type": "string"}, "court_name": {"title": "Court Name", "type": "string"}, "court_state": {"title": "Court State", "type": "string"}, "entity": {"title": "Sujeto", "type": "string"}, "fecha": {"title": "Fecha Acuerdo", "type": "string"}, "file": {"title": "Expediente", "type": "string"}, "tipo": {"title": "Tipo", "type": "string"}, "type": {"title": "Type", "type": "string"}}, "title": "Federal Match Details", "type": "object"}, "mx_federal_match": {"definitions": {"BestMatchSchema": {"description": "Schema of the details obtained from the matching.", "properties": {"abstract": {"title": "Sintesis", "type": "string"}, "authority": {"title": "Autoridad", "type": "string"}, "court_id": {"title": "Court Id", "type": "string"}, "court_name": {"title": "Court Name", "type": "string"}, "court_state": {"title": "Court State", "type": "string"}, "entity": {"title": "Sujeto", "type": "string"}, "fecha": {"title": "Fecha Acuerdo", "type": "string"}, "file": {"title": "Expediente", "type": "string"}, "tipo": {"title": "Tipo", "type": "string"}, "type": {"title": "Type", "type": "string"}}, "title": "Federal Match Details", "type": "object"}}, "description": "Details schema for federal_match report.", "properties": {"best_match": {"$ref": "#/components/schemas/BestMatchSchema"}, "best_score": {"title": "Best Score", "type": "integer"}, "message": {"title": "Message", "type": "string"}, "name": {"title": "Name", "type": "string"}, "search_hits": {"title": "Search Hits", "type": "integer"}}, "title": "Federal Match Details", "type": "object"}, "BestMatch": {"description": "State Match Best Match.", "properties": {"acuerdo_id": {"title": "Acuerdoid", "type": "integer"}, "area": {"title": "Area", "type": "string"}, "documento": {"title": "Documento", "type": "string"}, "extracto": {"title": "Extracto", "type": "string"}, "fecha_publicacion": {"title": "Fechapublicacion", "type": "string"}, "materia": {"title": "Materia", "type": "string"}, "naturaleza": {"title": "Naturaleza", "type": "string"}, "partes": {"items": {"type": "string"}, "title": "Partes", "type": "array"}, "type": {"title": "Type", "type": "string"}}, "title": "State Match Details", "type": "object"}, "definitions-Item": {"description": "State Match Item.", "properties": {"best_match": {"$ref": "#/components/schemas/BestMatch"}, "best_score": {"title": "Best Score", "type": "integer"}, "name": {"title": "Name", "type": "string"}, "state": {"title": "State", "type": "string"}, "state_code": {"title": "State Code", "type": "string"}}, "title": "State Match Details", "type": "object"}, "mx_state_match": {"definitions": {"BestMatch": {"description": "State Match Best Match.", "properties": {"acuerdo_id": {"title": "Acuerdoid", "type": "integer"}, "area": {"title": "Area", "type": "string"}, "documento": {"title": "Documento", "type": "string"}, "extracto": {"title": "Extracto", "type": "string"}, "fecha_publicacion": {"title": "Fechapublicacion", "type": "string"}, "materia": {"title": "Materia", "type": "string"}, "naturaleza": {"title": "Naturaleza", "type": "string"}, "partes": {"items": {"type": "string"}, "title": "Partes", "type": "array"}, "type": {"title": "Type", "type": "string"}}, "title": "State Match Details", "type": "object"}, "Item": {"description": "State Match Item.", "properties": {"best_match": {"$ref": "#/components/schemas/BestMatch"}, "best_score": {"title": "Best Score", "type": "integer"}, "name": {"title": "Name", "type": "string"}, "state": {"title": "State", "type": "string"}, "state_code": {"title": "State Code", "type": "string"}}, "title": "State Match Details", "type": "object"}}, "description": "State Match Details.", "properties": {"items": {"items": {"$ref": "#/components/schemas/definitions-Item"}, "title": "Items", "type": "array"}, "match_state": {"items": {"type": "string"}, "title": "Match State", "type": "array"}}, "title": "State Match Details", "type": "object"}, "mx_nss": {"description": "Details schema for nss report.", "properties": {"curp": {"title": "Curp", "type": "string"}, "full_name": {"title": "Full Name", "type": "string"}, "message": {"title": "Message", "type": "string"}, "nss": {"title": "Nss", "type": "string"}}, "title": "Nss Details", "type": "object"}, "mx_rfc": {"description": "Details schema for the rfc report.", "properties": {"message": {"title": "Message", "type": "string"}, "registration_year": {"title": "Registration Year", "type": "string"}, "rfc": {"title": "Rfc", "type": "string"}, "source_id": {"description": "The source used for the search.", "title": "Source", "type": "string"}, "success": {"title": "Success", "type": "boolean"}}, "title": "Rfc Details", "type": "object"}, "definitions-MovementsSchema": {"description": "Details schema for the Labor History Movements.", "properties": {"date": {"title": "Date", "type": "string"}, "salary": {"title": "Salary", "type": "string"}, "type": {"title": "Type", "type": "string"}}, "title": "Labor History Details", "type": "object"}, "LaborHistoryListSchema": {"description": "Details schema for the Labor History Details.", "properties": {"base_rate_salary": {"title": "Base Rate Salary", "type": "string"}, "company_name": {"title": "Company Name", "type": "string"}, "employer_id": {"title": "Employer Id", "type": "string"}, "end_date": {"title": "End Date", "type": "string"}, "federal_entity": {"title": "Federal Entity", "type": "string"}, "movements": {"items": {"$ref": "#/components/schemas/definitions-MovementsSchema"}, "title": "Movements", "type": "array"}, "start_date": {"title": "Start Date", "type": "string"}}, "title": "Labor History Details", "type": "object"}, "LaborHistoryDataSchema": {"description": "Details schema for the Labor History Details.", "properties": {"curp": {"title": "Curp", "type": "string"}, "full_name": {"title": "Full Name", "type": "string"}, "labor_history": {"items": {"$ref": "#/components/schemas/LaborHistoryListSchema"}, "title": "Labor History", "type": "array"}, "nss": {"title": "Nss", "type": "string"}, "success": {"title": "Success", "type": "boolean"}, "total_qw": {"title": "Total Qw", "type": "string"}, "weeks_discounted": {"title": "Weeks Discounted", "type": "string"}, "weeks_returned": {"title": "Weeks Returned", "type": "string"}}, "title": "Labor History Details", "type": "object"}, "mx_labor_history": {"definitions": {"LaborHistoryDataSchema": {"description": "Details schema for the Labor History Details.", "properties": {"curp": {"title": "Curp", "type": "string"}, "full_name": {"title": "Full Name", "type": "string"}, "labor_history": {"items": {"$ref": "#/components/schemas/LaborHistoryListSchema"}, "title": "Labor History", "type": "array"}, "nss": {"title": "Nss", "type": "string"}, "success": {"title": "Success", "type": "boolean"}, "total_qw": {"title": "Total Qw", "type": "string"}, "weeks_discounted": {"title": "Weeks Discounted", "type": "string"}, "weeks_returned": {"title": "Weeks Returned", "type": "string"}}, "title": "Labor History Details", "type": "object"}, "LaborHistoryListSchema": {"description": "Details schema for the Labor History Details.", "properties": {"base_rate_salary": {"title": "Base Rate Salary", "type": "string"}, "company_name": {"title": "Company Name", "type": "string"}, "employer_id": {"title": "Employer Id", "type": "string"}, "end_date": {"title": "End Date", "type": "string"}, "federal_entity": {"title": "Federal Entity", "type": "string"}, "movements": {"items": {"$ref": "#/components/schemas/definitions-MovementsSchema"}, "title": "Movements", "type": "array"}, "start_date": {"title": "Start Date", "type": "string"}}, "title": "Labor History Details", "type": "object"}, "MovementsSchema": {"description": "Details schema for the Labor History Movements.", "properties": {"date": {"title": "Date", "type": "string"}, "salary": {"title": "Salary", "type": "string"}, "type": {"title": "Type", "type": "string"}}, "title": "Labor History Details", "type": "object"}}, "description": "Details schema for the Labor History report.", "properties": {"detailed_state": {"title": "Detailed State", "type": "string"}, "labor_history": {"$ref": "#/components/schemas/LaborHistoryDataSchema"}, "message": {"title": "Message", "type": "string"}, "state": {"title": "State", "type": "string"}}, "title": "Labor History Details", "type": "object"}, "mx_professional_license": {"description": "Details schema for professional_license report.", "properties": {"list": {"items": {"type": "object"}, "title": "List", "type": "array"}, "message": {"title": "Message", "type": "string"}}, "title": "Professional License Details", "type": "object"}, "RobberyReportsSchema": {"description": "Robbery reports schema.", "properties": {"date_of_inquiry": {"title": "Date Of Inquiry", "type": "string"}, "date_of_recovery": {"title": "Date Of Recovery", "type": "string"}, "date_of_theft": {"title": "Date Of Theft", "type": "string"}, "recovered_by": {"title": "Recovered By", "type": "string"}, "reported_by": {"title": "Reported By", "type": "string"}, "sourced_by": {"title": "Sourced By", "type": "string"}, "status": {"title": "Status", "type": "string"}, "updated_at": {"title": "Updated At", "type": "string"}}, "title": "Vehicle Check Details", "type": "object"}, "mx_vehicle_check": {"definitions": {"RobberyReportsSchema": {"description": "Robbery reports schema.", "properties": {"date_of_inquiry": {"title": "Date Of Inquiry", "type": "string"}, "date_of_recovery": {"title": "Date Of Recovery", "type": "string"}, "date_of_theft": {"title": "Date Of Theft", "type": "string"}, "recovered_by": {"title": "Recovered By", "type": "string"}, "reported_by": {"title": "Reported By", "type": "string"}, "sourced_by": {"title": "Sourced By", "type": "string"}, "status": {"title": "Status", "type": "string"}, "updated_at": {"title": "Updated At", "type": "string"}}, "title": "Vehicle Check Details", "type": "object"}}, "description": "Details schema for the esocial report.", "properties": {"brand": {"title": "Brand", "type": "string"}, "doors": {"title": "Doors", "type": "string"}, "license_plate": {"title": "License Plate", "type": "string"}, "message": {"title": "Message", "type": "string"}, "model": {"title": "Model", "type": "string"}, "nci": {"title": "Nci", "type": "string"}, "niv": {"title": "Niv", "type": "string"}, "origin_country": {"title": "Origin Country", "type": "string"}, "register_date": {"title": "Register Date", "type": "string"}, "register_state": {"title": "Register State", "type": "string"}, "robbery_reports": {"items": {"$ref": "#/components/schemas/RobberyReportsSchema"}, "title": "Robbery Reports", "type": "array"}, "updated_date": {"title": "Updated Date", "type": "string"}, "vehicle_class": {"title": "Class", "type": "string"}, "vehicle_type": {"title": "Type", "type": "string"}, "year": {"title": "Year", "type": "string"}}, "title": "Vehicle Check Details", "type": "object"}, "mx_license_status": {"description": "Details schema for Mexico license_status report.", "properties": {"address": {"title": "Address", "type": "object"}, "blood_type": {"title": "Blood Type", "type": "string"}, "category": {"items": {"type": "string"}, "title": "Category", "type": "array"}, "dob": {"title": "Dob", "type": "string"}, "document_id": {"title": "Document Id", "type": "string"}, "drivers_license_id": {"title": "Drivers License Id", "type": "string"}, "due_date": {"title": "Due Date", "type": "string"}, "error": {"title": "Error", "type": "string"}, "expires_date": {"title": "Expires Date", "type": "string"}, "forename": {"title": "Forename", "type": "string"}, "full_name": {"title": "Full Name", "type": "string"}, "issue_date": {"title": "Issue Date", "type": "string"}, "last_medical_exam": {"title": "Last Medical Exam", "type": "object"}, "last_renewal": {"title": "Last Renewal", "type": "object"}, "message": {"title": "Message", "type": "string"}, "not_found": {"title": "Not Found", "type": "boolean"}, "observations": {"title": "Observations", "type": "string"}, "status": {"title": "Status", "type": "string"}, "surname": {"title": "Surname", "type": "string"}, "type": {"title": "Type", "type": "string"}}, "title": "License Status Details", "type": "object"}, "mx_news_search": {"definitions": {"Summary": {"description": "Summary schema for the news_search report.", "properties": {"relevant": {"description": "Whether the summary is relevant.", "title": "Relevant", "type": "boolean"}, "summary": {"description": "Summary of the news article.", "title": "Summary", "type": "string"}, "web_page_url": {"description": "URL of the news article.", "title": "Web Page Url", "type": "string"}}, "title": "News Search Details", "type": "object"}}, "description": "Details schema for the news_search report.", "properties": {"full_name": {"description": "Query used to search for the person.", "title": "Full Name", "type": "string"}, "message": {"title": "Message", "type": "string"}, "summaries": {"description": "List of AI generated summaries.", "items": {"$ref": "#/components/schemas/Summary"}, "title": "Summaries", "type": "array"}}, "title": "News Search Details", "type": "object"}, "DataSimplified": {"description": "Data simplified schema.", "properties": {"acto_reclamado": {"title": "Acto Reclamado"}, "acto_reclamado_especifico": {"title": "Acto Reclamado Especifico"}, "acto_reclamado_expediente_de_origen": {"title": "Acto Reclamado Expediente De Origen"}, "materia": {"title": "Materia"}, "resolucion_que_pone_fin": {"title": "Resolucion Que Pone Fin"}, "sentence_link": {"title": "Sentence Link"}, "submateria": {"title": "Submateria"}}, "title": "Federal Records Details", "type": "object"}, "RecordDetails": {"description": "Match found in support data.", "properties": {"acuerdos_simplified": {"title": "Acuerdos Simplified", "type": "object"}, "custom_id": {"title": "Custom Id", "type": "string"}, "data_simplified": {"$ref": "#/components/schemas/DataSimplified"}, "expediente_simplified": {"title": "Expediente Simplified", "type": "object"}, "sentenciadocs_simplified": {"title": "Sentenciadocs Simplified", "type": "object"}}, "title": "Federal Records Details", "type": "object"}, "RecordPublication": {"description": "Match details found.", "properties": {"actor": {"title": "Actor", "type": "string"}, "autoridad": {"title": "Autoridad", "type": "string"}, "court_id": {"title": "Court Id", "type": "string"}, "court_name": {"title": "Court Name", "type": "string"}, "court_state": {"title": "Court State", "type": "string"}, "demandado": {"title": "Demandado", "type": "string"}, "expediente": {"title": "Expediente", "type": "string"}, "fecha_acuerdo": {"title": "Fecha Acuerdo", "type": "string"}, "publication_type": {"title": "Publication Type", "type": "string"}, "sintesis": {"title": "Sintesis", "type": "string"}, "sujeto": {"title": "Sujeto", "type": "string"}, "tabla": {"title": "Tabla", "type": "string"}, "tipo": {"title": "Tipo", "type": "string"}}, "title": "Federal Records Details", "type": "object"}, "DetailsItem": {"description": "Details item schema for the federal_records report.", "properties": {"record_details": {"allOf": [{"$ref": "#/components/schemas/RecordDetails"}], "description": "Additional details related to the record found.", "title": "Record Details"}, "record_publication": {"allOf": [{"$ref": "#/components/schemas/RecordPublication"}], "description": "Publication details that matched.", "title": "Record Publication"}}, "title": "Federal Records Details", "type": "object"}, "mx_federal_records": {"definitions": {"DataSimplified": {"description": "Data simplified schema.", "properties": {"acto_reclamado": {"title": "Acto Reclamado"}, "acto_reclamado_especifico": {"title": "Acto Reclamado Especifico"}, "acto_reclamado_expediente_de_origen": {"title": "Acto Reclamado Expediente De Origen"}, "materia": {"title": "Materia"}, "resolucion_que_pone_fin": {"title": "Resolucion Que Pone Fin"}, "sentence_link": {"title": "Sentence Link"}, "submateria": {"title": "Submateria"}}, "title": "Federal Records Details", "type": "object"}, "DetailsItem": {"description": "Details item schema for the federal_records report.", "properties": {"record_details": {"allOf": [{"$ref": "#/components/schemas/RecordDetails"}], "description": "Additional details related to the record found.", "title": "Record Details"}, "record_publication": {"allOf": [{"$ref": "#/components/schemas/RecordPublication"}], "description": "Publication details that matched.", "title": "Record Publication"}}, "title": "Federal Records Details", "type": "object"}, "RecordDetails": {"description": "Match found in support data.", "properties": {"acuerdos_simplified": {"title": "Acuerdos Simplified", "type": "object"}, "custom_id": {"title": "Custom Id", "type": "string"}, "data_simplified": {"$ref": "#/components/schemas/DataSimplified"}, "expediente_simplified": {"title": "Expediente Simplified", "type": "object"}, "sentenciadocs_simplified": {"title": "Sentenciadocs Simplified", "type": "object"}}, "title": "Federal Records Details", "type": "object"}, "RecordPublication": {"description": "Match details found.", "properties": {"actor": {"title": "Actor", "type": "string"}, "autoridad": {"title": "Autoridad", "type": "string"}, "court_id": {"title": "Court Id", "type": "string"}, "court_name": {"title": "Court Name", "type": "string"}, "court_state": {"title": "Court State", "type": "string"}, "demandado": {"title": "Demandado", "type": "string"}, "expediente": {"title": "Expediente", "type": "string"}, "fecha_acuerdo": {"title": "Fecha Acuerdo", "type": "string"}, "publication_type": {"title": "Publication Type", "type": "string"}, "sintesis": {"title": "Sintesis", "type": "string"}, "sujeto": {"title": "Sujeto", "type": "string"}, "tabla": {"title": "Tabla", "type": "string"}, "tipo": {"title": "Tipo", "type": "string"}}, "title": "Federal Records Details", "type": "object"}}, "description": "Details schema for the federal_records report.", "properties": {"amparo": {"description": "List of amparo records.", "items": {"$ref": "#/components/schemas/DetailsItem"}, "title": "Amparo", "type": "array"}, "civil_administrativa": {"description": "List of civil/administrativa records.", "items": {"$ref": "#/components/schemas/DetailsItem"}, "title": "Civil Administrativa", "type": "array"}, "dismissed_records": {"default": false, "description": "Whether records were dismissed.", "title": "Dismissed Records", "type": "boolean"}, "found_records": {"default": false, "description": "Whether records were found.", "title": "Found Records", "type": "boolean"}, "full_name": {"default": "", "description": "Query used to search for the person.", "title": "Full Name", "type": "string"}, "message": {"title": "Message", "type": "string"}, "penal": {"description": "List of penal records.", "items": {"$ref": "#/components/schemas/DetailsItem"}, "title": "Penal", "type": "array"}}, "title": "Federal Records Details", "type": "object"}, "mx_name_check": {"description": "Details schema for the name_check report.", "properties": {"full_name": {"title": "Full Name", "type": "string"}, "message": {"title": "Message", "type": "string"}, "name_fragment_check": {"title": "Name Fragment Check", "type": "boolean"}, "name_score_min": {"title": "Name Score Min", "type": "number"}, "score": {"title": "Score", "type": "number"}}, "required": ["score", "full_name", "name_fragment_check", "name_score_min"], "title": "Name Check Details", "type": "object"}, "mx_dob_check": {"description": "Details schema for the dob_check report.", "properties": {"dob": {"title": "Dob", "type": "string"}, "message": {"title": "Message", "type": "string"}}, "title": "Dob Check Details", "type": "object"}, "mx_sanctions": {"description": "Sanctions details schema.", "properties": {"found_matches": {"default": false, "title": "Found Matches", "type": "boolean"}, "ignored_items": {"items": {"type": "object"}, "title": "Ignored Items", "type": "array"}, "matches": {"additionalProperties": {"items": {"type": "object"}, "type": "array"}, "title": "Matches", "type": "object"}, "message": {"title": "Message", "type": "string"}}, "title": "Sanctions Details", "type": "object"}, "mx_one_of": {"oneOf": [{"$ref": "#/components/schemas/mx_federal_match"}, {"$ref": "#/components/schemas/mx_state_match"}, {"$ref": "#/components/schemas/mx_nss"}, {"$ref": "#/components/schemas/mx_rfc"}, {"$ref": "#/components/schemas/mx_labor_history"}, {"$ref": "#/components/schemas/mx_professional_license"}, {"$ref": "#/components/schemas/mx_vehicle_check"}, {"$ref": "#/components/schemas/mx_license_status"}, {"$ref": "#/components/schemas/mx_news_search"}, {"$ref": "#/components/schemas/mx_federal_records"}, {"$ref": "#/components/schemas/mx_name_check"}, {"$ref": "#/components/schemas/mx_dob_check"}, {"$ref": "#/components/schemas/mx_sanctions"}]}, "LicenseInfo": {"description": "License information.", "properties": {"category": {"title": "Category", "type": "string"}, "electronic_license": {"title": "Electronic License", "type": "boolean"}, "expires_at": {"title": "Expires At", "type": "string"}, "issued_at": {"title": "Issued At", "type": "string"}, "issuing_center": {"title": "Issuing Center", "type": "string"}, "license_no": {"title": "License No", "type": "string"}, "restrictions": {"title": "Restrictions", "type": "string"}, "status": {"title": "Status", "type": "string"}}, "title": "License Status Details", "type": "object"}, "pe_license_status": {"definitions": {"LicenseInfo": {"description": "License information.", "properties": {"category": {"title": "Category", "type": "string"}, "electronic_license": {"title": "Electronic License", "type": "boolean"}, "expires_at": {"title": "Expires At", "type": "string"}, "issued_at": {"title": "Issued At", "type": "string"}, "issuing_center": {"title": "Issuing Center", "type": "string"}, "license_no": {"title": "License No", "type": "string"}, "restrictions": {"title": "Restrictions", "type": "string"}, "status": {"title": "Status", "type": "string"}}, "title": "License Status Details", "type": "object"}}, "description": "Details schema for license_status report.", "properties": {"document_id": {"title": "Document Id", "type": "string"}, "document_id_type_name": {"title": "Document Id Type Name", "type": "string"}, "full_name": {"title": "Full Name", "type": "string"}, "is_valid": {"title": "Is Valid", "type": "boolean"}, "license_found": {"title": "License Found", "type": "boolean"}, "license_info": {"items": {"$ref": "#/components/schemas/LicenseInfo"}, "title": "License Info", "type": "array"}, "license_no": {"title": "License No", "type": "string"}, "license_status": {"title": "License Status", "type": "string"}, "message": {"title": "Message", "type": "string"}}, "title": "License Status Details", "type": "object"}, "Infraction": {"description": "Infraction (papeleta) information.", "properties": {"code": {"title": "Code", "type": "string"}, "date": {"title": "Date", "type": "string"}, "entity": {"title": "Entity", "type": "string"}, "ticket_id": {"title": "Ticket Id", "type": "string"}}, "title": "Drunk Driving Details", "type": "object"}, "pe_drunk_driving": {"definitions": {"Infraction": {"description": "Infraction (papeleta) information.", "properties": {"code": {"title": "Code", "type": "string"}, "date": {"title": "Date", "type": "string"}, "entity": {"title": "Entity", "type": "string"}, "ticket_id": {"title": "Ticket Id", "type": "string"}}, "title": "Drunk Driving Details", "type": "object"}}, "description": "Details schema for drunk_driving report.", "properties": {"document_id": {"title": "Document Id", "type": "string"}, "document_id_type_name": {"title": "Document Id Type Name", "type": "string"}, "drunk_driving": {"title": "Drunk Driving", "type": "boolean"}, "full_name": {"title": "Full Name", "type": "string"}, "has_fines": {"title": "Has Fines", "type": "boolean"}, "infractions": {"items": {"$ref": "#/components/schemas/Infraction"}, "title": "Infractions", "type": "array"}, "license_found": {"title": "License Found", "type": "boolean"}, "license_no": {"title": "License No", "type": "string"}, "license_status": {"title": "License Status", "type": "string"}, "message": {"title": "Message", "type": "string"}}, "title": "Drunk Driving Details", "type": "object"}, "definitions-Infraction": {"description": "Infraction (papeleta) information.", "properties": {"code": {"title": "Code", "type": "string"}, "date": {"title": "Date", "type": "string"}, "entity": {"title": "Entity", "type": "string"}, "ticket_id": {"title": "Ticket Id", "type": "string"}}, "title": "Dangerous Driver Details", "type": "object"}, "pe_dangerous_driver": {"definitions": {"Infraction": {"description": "Infraction (papeleta) information.", "properties": {"code": {"title": "Code", "type": "string"}, "date": {"title": "Date", "type": "string"}, "entity": {"title": "Entity", "type": "string"}, "ticket_id": {"title": "Ticket Id", "type": "string"}}, "title": "Dangerous Driver Details", "type": "object"}}, "description": "Details schema for dangerous_driver report.", "properties": {"abusive_infractions": {"title": "Abusive Infractions", "type": "integer"}, "document_id": {"title": "Document Id", "type": "string"}, "document_id_type_name": {"title": "Document Id Type Name", "type": "string"}, "full_name": {"title": "Full Name", "type": "string"}, "infractions": {"items": {"$ref": "#/components/schemas/definitions-Infraction"}, "title": "Infractions", "type": "array"}, "is_dangerous_driver": {"title": "Is Dangerous Driver", "type": "boolean"}, "license_found": {"title": "License Found", "type": "boolean"}, "license_no": {"title": "License No", "type": "string"}, "license_status": {"title": "License Status", "type": "string"}, "message": {"title": "Message", "type": "string"}}, "title": "Dangerous Driver Details", "type": "object"}, "pe_document_id_status": {"description": "Details schema for document id status report.", "properties": {"civil_state": {"title": "Civil State", "type": "string"}, "dob": {"title": "Dob", "type": "string"}, "document_id": {"title": "Document Id", "type": "string"}, "document_id_type": {"title": "Document Id Type", "type": "string"}, "father_surname": {"title": "Father Surname", "type": "string"}, "full_name": {"title": "Full Name", "type": "string"}, "message": {"title": "Message", "type": "string"}, "mother_surname": {"title": "Mother Surname", "type": "string"}, "names": {"title": "Names", "type": "string"}, "not_found": {"title": "Not Found", "type": "boolean"}, "ruc": {"title": "Ruc", "type": "string"}, "verification_code": {"title": "Verification Code", "type": "string"}}, "title": "Document Id Status Details", "type": "object"}, "pe_sanctions": {"description": "Sanctions details schema.", "properties": {"found_matches": {"default": false, "title": "Found Matches", "type": "boolean"}, "ignored_items": {"items": {"type": "object"}, "title": "Ignored Items", "type": "array"}, "matches": {"additionalProperties": {"items": {"type": "object"}, "type": "array"}, "title": "Matches", "type": "object"}, "message": {"title": "Message", "type": "string"}}, "title": "Sanctions Details", "type": "object"}, "pe_name_check": {"description": "Details schema for the name_check report.", "properties": {"full_name": {"title": "Full Name", "type": "string"}, "message": {"title": "Message", "type": "string"}, "name_fragment_check": {"title": "Name Fragment Check", "type": "boolean"}, "name_score_min": {"title": "Name Score Min", "type": "number"}, "score": {"title": "Score", "type": "number"}}, "required": ["score", "full_name", "name_fragment_check", "name_score_min"], "title": "Name Check Details", "type": "object"}, "pe_news_search": {"definitions": {"Summary": {"description": "Summary schema for the news_search report.", "properties": {"relevant": {"description": "Whether the summary is relevant.", "title": "Relevant", "type": "boolean"}, "summary": {"description": "Summary of the news article.", "title": "Summary", "type": "string"}, "web_page_url": {"description": "URL of the news article.", "title": "Web Page Url", "type": "string"}}, "title": "News Search Details", "type": "object"}}, "description": "Details schema for the news_search report.", "properties": {"full_name": {"description": "Query used to search for the person.", "title": "Full Name", "type": "string"}, "message": {"title": "Message", "type": "string"}, "summaries": {"description": "List of AI generated summaries.", "items": {"$ref": "#/components/schemas/Summary"}, "title": "Summaries", "type": "array"}}, "title": "News Search Details", "type": "object"}, "pe_one_of": {"oneOf": [{"$ref": "#/components/schemas/pe_license_status"}, {"$ref": "#/components/schemas/pe_drunk_driving"}, {"$ref": "#/components/schemas/pe_dangerous_driver"}, {"$ref": "#/components/schemas/pe_document_id_status"}, {"$ref": "#/components/schemas/pe_sanctions"}, {"$ref": "#/components/schemas/pe_name_check"}, {"$ref": "#/components/schemas/pe_news_search"}]}, "cl_run_status": {"description": "Details schema for the run status report.", "properties": {"dob": {"title": "Dob", "type": "string"}, "fathers_full_name": {"title": "Fathers Full Name", "type": "string"}, "fathers_run": {"title": "Fathers Run", "type": "string"}, "full_name": {"title": "Full Name", "type": "string"}, "full_name_reversed": {"title": "Full Name Reversed", "type": "boolean"}, "gender": {"title": "Gender", "type": "string"}, "message": {"title": "Message", "type": "string"}, "mothers_full_name": {"title": "Mothers Full Name", "type": "string"}, "mothers_run": {"title": "Mothers Run", "type": "string"}, "not_found": {"title": "Not Found", "type": "boolean"}, "run": {"title": "Run", "type": "string"}, "run_state": {"title": "Run State", "type": "string"}, "success": {"title": "Success", "type": "boolean"}}, "title": "Run Status Details", "type": "object"}, "cl_license_status": {"description": "Details schema for the license status report.", "properties": {"license_status": {"title": "License Status", "type": "string"}, "message": {"title": "Message", "type": "string"}}, "title": "License Status Details", "type": "object"}, "CriminalRecordItems": {"description": "Criminal record items schema.", "properties": {"court_id": {"title": "Court Id", "type": "string"}, "court_name": {"title": "Court Name", "type": "string"}, "date": {"title": "Date", "type": "string"}, "history": {"items": {"type": "object"}, "title": "History", "type": "array"}, "litigants": {"items": {"type": "object"}, "title": "Litigants", "type": "array"}, "notifications": {"items": {"type": "object"}, "title": "Notifications", "type": "array"}, "parts": {"title": "Parts", "type": "string"}, "process_type": {"title": "Process Type", "type": "string"}, "relations": {"items": {"type": "object"}, "title": "Relations", "type": "array"}, "rin": {"title": "Rin", "type": "string"}, "ruc": {"title": "Ruc", "type": "string"}, "stage": {"title": "Stage", "type": "string"}, "tribunal_id": {"title": "Tribunal Id", "type": "string"}, "tribunal_name": {"title": "Tribunal Name", "type": "string"}, "year": {"title": "Year", "type": "string"}}, "title": "Criminal Details", "type": "object"}, "cl_criminal": {"definitions": {"CriminalRecordItems": {"description": "Criminal record items schema.", "properties": {"court_id": {"title": "Court Id", "type": "string"}, "court_name": {"title": "Court Name", "type": "string"}, "date": {"title": "Date", "type": "string"}, "history": {"items": {"type": "object"}, "title": "History", "type": "array"}, "litigants": {"items": {"type": "object"}, "title": "Litigants", "type": "array"}, "notifications": {"items": {"type": "object"}, "title": "Notifications", "type": "array"}, "parts": {"title": "Parts", "type": "string"}, "process_type": {"title": "Process Type", "type": "string"}, "relations": {"items": {"type": "object"}, "title": "Relations", "type": "array"}, "rin": {"title": "Rin", "type": "string"}, "ruc": {"title": "Ruc", "type": "string"}, "stage": {"title": "Stage", "type": "string"}, "tribunal_id": {"title": "Tribunal Id", "type": "string"}, "tribunal_name": {"title": "Tribunal Name", "type": "string"}, "year": {"title": "Year", "type": "string"}}, "title": "Criminal Details", "type": "object"}}, "description": "Details schema for the criminal report.", "properties": {"items": {"default": [], "items": {"$ref": "#/components/schemas/CriminalRecordItems"}, "title": "Items", "type": "array"}, "message": {"title": "Message", "type": "string"}}, "title": "Criminal Details", "type": "object"}, "ServiceInformation": {"description": "Service schema.", "properties": {"associated_fleet": {"title": "Associated Fleet", "type": "string"}, "service_document_number": {"title": "Service Document Number", "type": "string"}, "service_manager": {"title": "Service Manager", "type": "string"}, "service_status": {"title": "Service Status", "type": "string"}}, "title": "Mtt Taxi Details", "type": "object"}, "VehicleInformation": {"description": "Vehicle schema.", "properties": {"brand": {"title": "Brand", "type": "string"}, "capacity": {"title": "Capacity", "type": "string"}, "entry_date": {"title": "Entry Date", "type": "string"}, "license_plate": {"title": "License Plate", "type": "string"}, "mandatory_seat_belt": {"title": "Mandatory Seat Belt", "type": "string"}, "manufactoring_year": {"title": "Manufactoring Year", "type": "string"}, "model": {"title": "Model", "type": "string"}, "region": {"title": "Region", "type": "string"}, "type_of_service": {"title": "Type Of Service", "type": "string"}, "vehicle_age": {"title": "Vehicle Age", "type": "string"}, "vehicle_status": {"title": "Vehicle Status", "type": "string"}}, "title": "Mtt Taxi Details", "type": "object"}, "cl_mtt_taxi": {"definitions": {"ServiceInformation": {"description": "Service schema.", "properties": {"associated_fleet": {"title": "Associated Fleet", "type": "string"}, "service_document_number": {"title": "Service Document Number", "type": "string"}, "service_manager": {"title": "Service Manager", "type": "string"}, "service_status": {"title": "Service Status", "type": "string"}}, "title": "Mtt Taxi Details", "type": "object"}, "VehicleInformation": {"description": "Vehicle schema.", "properties": {"brand": {"title": "Brand", "type": "string"}, "capacity": {"title": "Capacity", "type": "string"}, "entry_date": {"title": "Entry Date", "type": "string"}, "license_plate": {"title": "License Plate", "type": "string"}, "mandatory_seat_belt": {"title": "Mandatory Seat Belt", "type": "string"}, "manufactoring_year": {"title": "Manufactoring Year", "type": "string"}, "model": {"title": "Model", "type": "string"}, "region": {"title": "Region", "type": "string"}, "type_of_service": {"title": "Type Of Service", "type": "string"}, "vehicle_age": {"title": "Vehicle Age", "type": "string"}, "vehicle_status": {"title": "Vehicle Status", "type": "string"}}, "title": "Mtt Taxi Details", "type": "object"}}, "description": "Mtt Taxi schema.", "properties": {"accompanying_adults": {"items": {}, "title": "Accompanying Adults", "type": "array"}, "drivers": {"items": {}, "title": "Drivers", "type": "array"}, "message": {"title": "Message", "type": "string"}, "service_information": {"allOf": [{"$ref": "#/components/schemas/ServiceInformation"}], "default": {"associated_fleet": null, "service_document_number": null, "service_manager": null, "service_status": null}, "title": "Service Information"}, "vehicle_information": {"allOf": [{"$ref": "#/components/schemas/VehicleInformation"}], "default": {"brand": null, "capacity": null, "entry_date": null, "license_plate": null, "mandatory_seat_belt": null, "manufactoring_year": null, "model": null, "region": null, "type_of_service": null, "vehicle_age": null, "vehicle_status": null}, "title": "Vehicle Information"}}, "title": "Mtt Taxi Details", "type": "object"}, "cl_vehicle_check": {"description": "Vehicle Check details schema.", "properties": {"sem": {"title": "Sem", "type": "object"}, "vehicle_info": {"title": "Vehicle Info", "type": "object"}}, "title": "Vehicle Check Details", "type": "object"}, "cl_sanctions": {"description": "Sanctions details schema.", "properties": {"found_matches": {"default": false, "title": "Found Matches", "type": "boolean"}, "ignored_items": {"items": {"type": "object"}, "title": "Ignored Items", "type": "array"}, "matches": {"additionalProperties": {"items": {"type": "object"}, "type": "array"}, "title": "Matches", "type": "object"}, "message": {"title": "Message", "type": "string"}}, "title": "Sanctions Details", "type": "object"}, "cl_name_check": {"description": "Details schema for the name_check report.", "properties": {"full_name": {"title": "Full Name", "type": "string"}, "message": {"title": "Message", "type": "string"}, "name_fragment_check": {"title": "Name Fragment Check", "type": "boolean"}, "name_score_min": {"title": "Name Score Min", "type": "number"}, "score": {"title": "Score", "type": "number"}}, "required": ["score", "full_name", "name_fragment_check", "name_score_min"], "title": "Name Check Details", "type": "object"}, "cl_news_search": {"definitions": {"Summary": {"description": "Summary schema for the news_search report.", "properties": {"relevant": {"description": "Whether the summary is relevant.", "title": "Relevant", "type": "boolean"}, "summary": {"description": "Summary of the news article.", "title": "Summary", "type": "string"}, "web_page_url": {"description": "URL of the news article.", "title": "Web Page Url", "type": "string"}}, "title": "News Search Details", "type": "object"}}, "description": "Details schema for the news_search report.", "properties": {"full_name": {"description": "Query used to search for the person.", "title": "Full Name", "type": "string"}, "message": {"title": "Message", "type": "string"}, "summaries": {"description": "List of AI generated summaries.", "items": {"$ref": "#/components/schemas/Summary"}, "title": "Summaries", "type": "array"}}, "title": "News Search Details", "type": "object"}, "cl_one_of": {"oneOf": [{"$ref": "#/components/schemas/cl_run_status"}, {"$ref": "#/components/schemas/cl_license_status"}, {"$ref": "#/components/schemas/cl_criminal"}, {"$ref": "#/components/schemas/cl_mtt_taxi"}, {"$ref": "#/components/schemas/cl_vehicle_check"}, {"$ref": "#/components/schemas/cl_sanctions"}, {"$ref": "#/components/schemas/cl_name_check"}, {"$ref": "#/components/schemas/cl_news_search"}]}, "cr_cedula_status": {"description": "Generic Details schema.", "properties": {"message": {"title": "Message", "type": "string"}}, "title": "Cedula Status Details", "type": "object"}, "cr_name_check": {"description": "Details schema for the name_check report.", "properties": {"full_name": {"title": "Full Name", "type": "string"}, "message": {"title": "Message", "type": "string"}, "name_fragment_check": {"title": "Name Fragment Check", "type": "boolean"}, "name_score_min": {"title": "Name Score Min", "type": "number"}, "score": {"title": "Score", "type": "number"}}, "required": ["score", "full_name", "name_fragment_check", "name_score_min"], "title": "Name Check Details", "type": "object"}, "cr_dob_check": {"description": "Details schema for the dob_check report.", "properties": {"dob": {"title": "Dob", "type": "string"}, "message": {"title": "Message", "type": "string"}}, "title": "Dob Check Details", "type": "object"}, "cr_sanctions": {"description": "Sanctions details schema.", "properties": {"found_matches": {"default": false, "title": "Found Matches", "type": "boolean"}, "ignored_items": {"items": {"type": "object"}, "title": "Ignored Items", "type": "array"}, "matches": {"additionalProperties": {"items": {"type": "object"}, "type": "array"}, "title": "Matches", "type": "object"}, "message": {"title": "Message", "type": "string"}}, "title": "Sanctions Details", "type": "object"}, "cr_news_search": {"definitions": {"Summary": {"description": "Summary schema for the news_search report.", "properties": {"relevant": {"description": "Whether the summary is relevant.", "title": "Relevant", "type": "boolean"}, "summary": {"description": "Summary of the news article.", "title": "Summary", "type": "string"}, "web_page_url": {"description": "URL of the news article.", "title": "Web Page Url", "type": "string"}}, "title": "News Search Details", "type": "object"}}, "description": "Details schema for the news_search report.", "properties": {"full_name": {"description": "Query used to search for the person.", "title": "Full Name", "type": "string"}, "message": {"title": "Message", "type": "string"}, "summaries": {"description": "List of AI generated summaries.", "items": {"$ref": "#/components/schemas/Summary"}, "title": "Summaries", "type": "array"}}, "title": "News Search Details", "type": "object"}, "cr_one_of": {"oneOf": [{"$ref": "#/components/schemas/cr_cedula_status"}, {"$ref": "#/components/schemas/cr_name_check"}, {"$ref": "#/components/schemas/cr_dob_check"}, {"$ref": "#/components/schemas/cr_sanctions"}, {"$ref": "#/components/schemas/cr_news_search"}]}, "br_cpf_status": {"description": "Details schema for the name_check report.", "properties": {"cpf_status": {"title": "Cpf Status", "type": "string"}, "dob": {"title": "Dob", "type": "string"}, "full_name": {"title": "Full Name", "type": "string"}, "message": {"title": "Message", "type": "string"}}, "title": "Cpf Status Details", "type": "object"}, "ResultFields": {"description": "Schema of result fields.", "properties": {"date": {"title": "Date", "type": "string"}, "date_dmy": {"title": "Date Dmy", "type": "string"}, "dob": {"title": "Dob", "type": "string"}, "dob_dmy": {"title": "Dob Dmy", "type": "string"}, "fathers_name": {"title": "Fathers Name", "type": "string"}, "found_results": {"title": "Found Results", "type": "boolean"}, "full_name": {"title": "Full Name", "type": "string"}, "gender": {"title": "Gender", "type": "string"}, "item_id": {"title": "Item Id", "type": "integer"}, "job": {"title": "Job", "type": "string"}, "mothers_name": {"title": "Mothers Name", "type": "string"}, "nickname": {"title": "Nickname", "type": "string"}, "origin": {"title": "Origin", "type": "string"}, "previous_warrant_id": {"title": "Previous Warrant Id", "type": "string"}, "process_id": {"title": "Process Id", "type": "string"}, "process_type": {"title": "Process Type", "type": "string"}, "status": {"title": "Status", "type": "string"}, "subject_type": {"title": "Subject Type", "type": "string"}, "success": {"title": "Success", "type": "boolean"}, "warrant_description": {"title": "Warrant Description", "type": "string"}, "warrant_id": {"title": "Warrant Id", "type": "string"}, "warrant_id_formatted": {"title": "Warrant Id Formatted", "type": "string"}, "warrant_type": {"title": "Warrant Type", "type": "integer"}}, "title": "Arrest Warrants Details", "type": "object"}, "ItemsObjects": {"description": "Schema of items.", "properties": {"cpf": {"$ref": "#/components/schemas/ResultFields"}, "full_name": {"$ref": "#/components/schemas/ResultFields"}, "rg": {"$ref": "#/components/schemas/ResultFields"}, "type": {"title": "Type", "type": "string"}}, "title": "Arrest Warrants Details", "type": "object"}, "br_arrest_warrants": {"definitions": {"ItemsObjects": {"description": "Schema of items.", "properties": {"cpf": {"$ref": "#/components/schemas/ResultFields"}, "full_name": {"$ref": "#/components/schemas/ResultFields"}, "rg": {"$ref": "#/components/schemas/ResultFields"}, "type": {"title": "Type", "type": "string"}}, "title": "Arrest Warrants Details", "type": "object"}, "ResultFields": {"description": "Schema of result fields.", "properties": {"date": {"title": "Date", "type": "string"}, "date_dmy": {"title": "Date Dmy", "type": "string"}, "dob": {"title": "Dob", "type": "string"}, "dob_dmy": {"title": "Dob Dmy", "type": "string"}, "fathers_name": {"title": "Fathers Name", "type": "string"}, "found_results": {"title": "Found Results", "type": "boolean"}, "full_name": {"title": "Full Name", "type": "string"}, "gender": {"title": "Gender", "type": "string"}, "item_id": {"title": "Item Id", "type": "integer"}, "job": {"title": "Job", "type": "string"}, "mothers_name": {"title": "Mothers Name", "type": "string"}, "nickname": {"title": "Nickname", "type": "string"}, "origin": {"title": "Origin", "type": "string"}, "previous_warrant_id": {"title": "Previous Warrant Id", "type": "string"}, "process_id": {"title": "Process Id", "type": "string"}, "process_type": {"title": "Process Type", "type": "string"}, "status": {"title": "Status", "type": "string"}, "subject_type": {"title": "Subject Type", "type": "string"}, "success": {"title": "Success", "type": "boolean"}, "warrant_description": {"title": "Warrant Description", "type": "string"}, "warrant_id": {"title": "Warrant Id", "type": "string"}, "warrant_id_formatted": {"title": "Warrant Id Formatted", "type": "string"}, "warrant_type": {"title": "Warrant Type", "type": "integer"}}, "title": "Arrest Warrants Details", "type": "object"}}, "description": "Details schema for the name_check report.", "properties": {"items": {"items": {"$ref": "#/components/schemas/ItemsObjects"}, "title": "Items", "type": "array"}, "message": {"title": "Message", "type": "string"}}, "title": "Arrest Warrants Details", "type": "object"}, "br_police_records": {"description": "Details schema for the police_records report.", "properties": {"clean_record": {"title": "Clean Record", "type": "boolean"}, "message": {"title": "Message", "type": "string"}, "success": {"title": "Success", "type": "boolean"}}, "title": "Police Records Details", "type": "object"}, "ResultExtraInformation": {"description": "Schema of result part extra information item.", "properties": {"court": {"title": "Court", "type": "string"}, "date_distribution": {"title": "Date Distribution", "type": "string"}, "date_filed": {"title": "Date Filed", "type": "string"}, "district": {"title": "District", "type": "string"}, "extinct": {"title": "Extinct", "type": "string"}, "jurisdiction": {"title": "Jurisdiction", "type": "string"}}, "title": "Criminal Records Details", "type": "object"}, "ResultExtraMovementItem": {"description": "Schema of result part extra movement item.", "properties": {"author": {"title": "Author", "type": "string"}, "date": {"title": "Date", "type": "string"}, "description": {"title": "Description", "type": "string"}}, "title": "Criminal Records Details", "type": "object"}, "ResultExtraItem": {"description": "Schema of result extra item.", "properties": {"information": {"allOf": [{"$ref": "#/components/schemas/ResultExtraInformation"}], "default": {"court": null, "date_distribution": null, "date_filed": null, "district": null, "extinct": null, "jurisdiction": null}, "title": "Information"}, "movements": {"default": [], "items": {"$ref": "#/components/schemas/ResultExtraMovementItem"}, "title": "Movements", "type": "array"}}, "title": "Criminal Records Details", "type": "object"}, "ResultPartItem": {"description": "Schema of result part item.", "properties": {"name": {"title": "Name", "type": "string"}, "observations": {"title": "Observations", "type": "string"}, "role": {"title": "Role", "type": "string"}}, "title": "Criminal Records Details", "type": "object"}, "definitions-ResultItem": {"description": "Schema of result items.", "properties": {"extras": {"allOf": [{"$ref": "#/components/schemas/ResultExtraItem"}], "default": {"information": {"court": null, "date_distribution": null, "date_filed": null, "district": null, "extinct": null, "jurisdiction": null}, "movements": []}, "title": "Extras"}, "instance": {"title": "Instance", "type": "string"}, "old_process_id": {"title": "Old Process Id", "type": "string"}, "parts": {"default": [], "items": {"$ref": "#/components/schemas/ResultPartItem"}, "title": "Parts", "type": "array"}, "process_id": {"title": "Process Id", "type": "string"}, "process_type": {"title": "Process Type", "type": "string"}, "secrecy": {"title": "Secrecy", "type": "string"}, "subject_type": {"title": "Subject Type", "type": "string"}, "success": {"title": "Success", "type": "boolean"}}, "title": "Criminal Records Details", "type": "object"}, "br_criminal_records": {"definitions": {"ResultExtraInformation": {"description": "Schema of result part extra information item.", "properties": {"court": {"title": "Court", "type": "string"}, "date_distribution": {"title": "Date Distribution", "type": "string"}, "date_filed": {"title": "Date Filed", "type": "string"}, "district": {"title": "District", "type": "string"}, "extinct": {"title": "Extinct", "type": "string"}, "jurisdiction": {"title": "Jurisdiction", "type": "string"}}, "title": "Criminal Records Details", "type": "object"}, "ResultExtraItem": {"description": "Schema of result extra item.", "properties": {"information": {"allOf": [{"$ref": "#/components/schemas/ResultExtraInformation"}], "default": {"court": null, "date_distribution": null, "date_filed": null, "district": null, "extinct": null, "jurisdiction": null}, "title": "Information"}, "movements": {"default": [], "items": {"$ref": "#/components/schemas/ResultExtraMovementItem"}, "title": "Movements", "type": "array"}}, "title": "Criminal Records Details", "type": "object"}, "ResultExtraMovementItem": {"description": "Schema of result part extra movement item.", "properties": {"author": {"title": "Author", "type": "string"}, "date": {"title": "Date", "type": "string"}, "description": {"title": "Description", "type": "string"}}, "title": "Criminal Records Details", "type": "object"}, "ResultItem": {"description": "Schema of result items.", "properties": {"extras": {"allOf": [{"$ref": "#/components/schemas/ResultExtraItem"}], "default": {"information": {"court": null, "date_distribution": null, "date_filed": null, "district": null, "extinct": null, "jurisdiction": null}, "movements": []}, "title": "Extras"}, "instance": {"title": "Instance", "type": "string"}, "old_process_id": {"title": "Old Process Id", "type": "string"}, "parts": {"default": [], "items": {"$ref": "#/components/schemas/ResultPartItem"}, "title": "Parts", "type": "array"}, "process_id": {"title": "Process Id", "type": "string"}, "process_type": {"title": "Process Type", "type": "string"}, "secrecy": {"title": "Secrecy", "type": "string"}, "subject_type": {"title": "Subject Type", "type": "string"}, "success": {"title": "Success", "type": "boolean"}}, "title": "Criminal Records Details", "type": "object"}, "ResultPartItem": {"description": "Schema of result part item.", "properties": {"name": {"title": "Name", "type": "string"}, "observations": {"title": "Observations", "type": "string"}, "role": {"title": "Role", "type": "string"}}, "title": "Criminal Records Details", "type": "object"}}, "description": "Details schema for criminal_records report.", "properties": {"cpf_items": {"default": [], "items": {"$ref": "#/components/schemas/definitions-ResultItem"}, "title": "Cpf Items", "type": "array"}, "full_name_items": {"default": [], "items": {"$ref": "#/components/schemas/definitions-ResultItem"}, "title": "Full Name Items", "type": "array"}, "message": {"title": "Message", "type": "string"}}, "title": "Criminal Records Details", "type": "object"}, "br_sanctions": {"description": "Sanctions details schema.", "properties": {"found_matches": {"default": false, "title": "Found Matches", "type": "boolean"}, "ignored_items": {"items": {"type": "object"}, "title": "Ignored Items", "type": "array"}, "matches": {"additionalProperties": {"items": {"type": "object"}, "type": "array"}, "title": "Matches", "type": "object"}, "message": {"title": "Message", "type": "string"}}, "title": "Sanctions Details", "type": "object"}, "br_name_check": {"description": "Details schema for the name_check report.", "properties": {"full_name": {"title": "Full Name", "type": "string"}, "message": {"title": "Message", "type": "string"}, "name_fragment_check": {"title": "Name Fragment Check", "type": "boolean"}, "name_score_min": {"title": "Name Score Min", "type": "number"}, "score": {"title": "Score", "type": "number"}}, "required": ["score", "full_name", "name_fragment_check", "name_score_min"], "title": "Name Check Details", "type": "object"}, "br_dob_check": {"description": "Details schema for the dob_check report.", "properties": {"dob": {"title": "Dob", "type": "string"}, "message": {"title": "Message", "type": "string"}}, "title": "Dob Check Details", "type": "object"}, "br_news_search": {"definitions": {"Summary": {"description": "Summary schema for the news_search report.", "properties": {"relevant": {"description": "Whether the summary is relevant.", "title": "Relevant", "type": "boolean"}, "summary": {"description": "Summary of the news article.", "title": "Summary", "type": "string"}, "web_page_url": {"description": "URL of the news article.", "title": "Web Page Url", "type": "string"}}, "title": "News Search Details", "type": "object"}}, "description": "Details schema for the news_search report.", "properties": {"full_name": {"description": "Query used to search for the person.", "title": "Full Name", "type": "string"}, "message": {"title": "Message", "type": "string"}, "summaries": {"description": "List of AI generated summaries.", "items": {"$ref": "#/components/schemas/Summary"}, "title": "Summaries", "type": "array"}}, "title": "News Search Details", "type": "object"}, "Movement": {"description": "Movement schema for the state_records report.", "properties": {"date": {"description": "Date of movement.", "title": "Date", "type": "string"}, "movement": {"description": "Description of movement.", "title": "Movement", "type": "string"}}, "title": "State Records Details", "type": "object"}, "Extras": {"description": "Extra information schema for the state_records report.", "properties": {"court": {"description": "Court of match.", "title": "Court", "type": "string"}, "date": {"description": "Date of match.", "title": "Date", "type": "string"}, "movements": {"description": "Movements of match.", "items": {"$ref": "#/components/schemas/Movement"}, "title": "Movements", "type": "array"}}, "title": "State Records Details", "type": "object"}, "Part": {"description": "Part schema for the state_records report.", "properties": {"name": {"description": "Name of part.", "title": "Name", "type": "string"}, "role": {"description": "Role of part.", "title": "Role", "type": "string"}}, "title": "State Records Details", "type": "object"}, "SourceItem": {"description": "Individual record item schema obtained in a source.", "properties": {"annotation": {"description": "Annotation for the record.", "title": "Annotation", "type": "string"}, "extras": {"allOf": [{"$ref": "#/components/schemas/Extras"}], "description": "Extra information.", "title": "Extras"}, "flagged_by": {"description": "List of report settings that flagged the record.", "items": {"type": "string"}, "title": "Flagged By", "type": "array"}, "flagged_terms": {"description": "List of terms that flagged the record.", "items": {"type": "string"}, "title": "Flagged Terms", "type": "array"}, "parts": {"description": "Parts involved.", "items": {"$ref": "#/components/schemas/Part"}, "title": "Parts", "type": "array"}, "process_id": {"description": "Process ID of match.", "title": "Process Id", "type": "string"}, "process_type": {"description": "Process type of match.", "title": "Process Type", "type": "string"}, "relevant_record": {"default": false, "description": "Indicates whether the record is relevant.", "title": "Relevant Record", "type": "boolean"}, "subject_type": {"description": "Subject type of match.", "title": "Subject Type", "type": "string"}}, "title": "State Records Details", "type": "object"}, "ErrorItem": {"description": "Error item schema for the state_records report.", "properties": {"execution_name": {"description": "The execution name associated with the error.", "title": "Execution Name", "type": "string"}, "message": {"description": "The error message.", "title": "Message", "type": "string"}, "source_id": {"description": "The source associated with the error.", "title": "Source", "type": "string"}}, "required": ["message"], "title": "State Records Details", "type": "object"}, "br_state_records_definitions-Item": {"description": "Item schema for the state_records report.", "properties": {"found_relevant_records": {"default": false, "description": "Indicates whether relevant results were found.", "title": "Found Relevant Records", "type": "boolean"}, "found_results": {"description": "Indicates whether results were found.", "title": "Found Results", "type": "boolean"}, "items": {"anyOf": [{"type": "string"}, {"items": {"$ref": "#/components/schemas/SourceItem"}, "type": "array"}], "description": "State records results.", "title": "Items"}, "message": {"description": "A message related to the search results.", "title": "Message", "type": "string"}, "source_id": {"description": "The source used for the search.", "title": "Source", "type": "string"}}, "required": ["message", "found_results", "source_id", "items"], "title": "State Records Details", "type": "object"}, "br_state_records": {"definitions": {"ErrorItem": {"description": "Error item schema for the state_records report.", "properties": {"execution_name": {"description": "The execution name associated with the error.", "title": "Execution Name", "type": "string"}, "message": {"description": "The error message.", "title": "Message", "type": "string"}, "source_id": {"description": "The source associated with the error.", "title": "Source", "type": "string"}}, "required": ["message"], "title": "State Records Details", "type": "object"}, "Extras": {"description": "Extra information schema for the state_records report.", "properties": {"court": {"description": "Court of match.", "title": "Court", "type": "string"}, "date": {"description": "Date of match.", "title": "Date", "type": "string"}, "movements": {"description": "Movements of match.", "items": {"$ref": "#/components/schemas/Movement"}, "title": "Movements", "type": "array"}}, "title": "State Records Details", "type": "object"}, "Item": {"description": "Item schema for the state_records report.", "properties": {"found_relevant_records": {"default": false, "description": "Indicates whether relevant results were found.", "title": "Found Relevant Records", "type": "boolean"}, "found_results": {"description": "Indicates whether results were found.", "title": "Found Results", "type": "boolean"}, "items": {"anyOf": [{"type": "string"}, {"items": {"$ref": "#/components/schemas/SourceItem"}, "type": "array"}], "description": "State records results.", "title": "Items"}, "message": {"description": "A message related to the search results.", "title": "Message", "type": "string"}, "source_id": {"description": "The source used for the search.", "title": "Source", "type": "string"}}, "required": ["message", "found_results", "source_id", "items"], "title": "State Records Details", "type": "object"}, "Movement": {"description": "Movement schema for the state_records report.", "properties": {"date": {"description": "Date of movement.", "title": "Date", "type": "string"}, "movement": {"description": "Description of movement.", "title": "Movement", "type": "string"}}, "title": "State Records Details", "type": "object"}, "Part": {"description": "Part schema for the state_records report.", "properties": {"name": {"description": "Name of part.", "title": "Name", "type": "string"}, "role": {"description": "Role of part.", "title": "Role", "type": "string"}}, "title": "State Records Details", "type": "object"}, "SourceItem": {"description": "Individual record item schema obtained in a source.", "properties": {"annotation": {"description": "Annotation for the record.", "title": "Annotation", "type": "string"}, "extras": {"allOf": [{"$ref": "#/components/schemas/Extras"}], "description": "Extra information.", "title": "Extras"}, "flagged_by": {"description": "List of report settings that flagged the record.", "items": {"type": "string"}, "title": "Flagged By", "type": "array"}, "flagged_terms": {"description": "List of terms that flagged the record.", "items": {"type": "string"}, "title": "Flagged Terms", "type": "array"}, "parts": {"description": "Parts involved.", "items": {"$ref": "#/components/schemas/Part"}, "title": "Parts", "type": "array"}, "process_id": {"description": "Process ID of match.", "title": "Process Id", "type": "string"}, "process_type": {"description": "Process type of match.", "title": "Process Type", "type": "string"}, "relevant_record": {"default": false, "description": "Indicates whether the record is relevant.", "title": "Relevant Record", "type": "boolean"}, "subject_type": {"description": "Subject type of match.", "title": "Subject Type", "type": "string"}}, "title": "State Records Details", "type": "object"}}, "description": "Details schema for the state_records report.", "properties": {"error_items": {"description": "List of error items, if any.", "items": {"$ref": "#/components/schemas/ErrorItem"}, "title": "Error Items", "type": "array"}, "found_records": {"default": false, "description": "Indicates whether results were found in all sources.", "title": "Found Records", "type": "boolean"}, "found_relevant_records": {"default": false, "description": "Indicates whether relevant results were found in all sources.", "title": "Found Relevant Records", "type": "boolean"}, "items": {"description": "List of items containing search results.", "items": {"$ref": "#/components/schemas/br_state_records_definitions-Item"}, "title": "Items", "type": "array"}, "message": {"title": "Message", "type": "string"}}, "title": "State Records Details", "type": "object"}, "br_one_of": {"oneOf": [{"$ref": "#/components/schemas/br_cpf_status"}, {"$ref": "#/components/schemas/br_arrest_warrants"}, {"$ref": "#/components/schemas/br_police_records"}, {"$ref": "#/components/schemas/br_criminal_records"}, {"$ref": "#/components/schemas/br_sanctions"}, {"$ref": "#/components/schemas/br_name_check"}, {"$ref": "#/components/schemas/br_dob_check"}, {"$ref": "#/components/schemas/br_news_search"}, {"$ref": "#/components/schemas/br_state_records"}]}, "ar_id_status": {"description": "Details schema for id_status report.", "properties": {"full_name": {"title": "Full Name", "type": "string"}, "message": {"title": "Message", "type": "string"}, "status": {"title": "Status", "type": "string"}}, "title": "Id Status Details", "type": "object"}, "definitions-DetailsItem": {"description": "Details item schema for criminal search report.", "properties": {"date": {"title": "Date", "type": "string"}, "file_name": {"title": "File Name", "type": "string"}, "id": {"title": "Id", "type": "string"}, "item_type": {"title": "Item Type", "type": "string"}, "name_score": {"title": "Name Score", "type": "number"}, "page": {"title": "Page", "type": "string"}, "pdf_to_download": {"title": "Pdf To Download", "type": "string"}, "text": {"title": "Text", "type": "string"}, "url": {"title": "Url", "type": "string"}}, "title": "Criminal Search Details", "type": "object"}, "IgnoredItem": {"description": "Ignored items reasons, source and details.", "properties": {"details": {"$ref": "#/components/schemas/definitions-DetailsItem"}, "ignored_reason": {"title": "Ignored Reason", "type": "string"}, "source": {"title": "Source", "type": "string"}}, "required": ["source", "details", "ignored_reason"], "title": "Criminal Search Details", "type": "object"}, "ar_criminal_search": {"definitions": {"DetailsItem": {"description": "Details item schema for criminal search report.", "properties": {"date": {"title": "Date", "type": "string"}, "file_name": {"title": "File Name", "type": "string"}, "id": {"title": "Id", "type": "string"}, "item_type": {"title": "Item Type", "type": "string"}, "name_score": {"title": "Name Score", "type": "number"}, "page": {"title": "Page", "type": "string"}, "pdf_to_download": {"title": "Pdf To Download", "type": "string"}, "text": {"title": "Text", "type": "string"}, "url": {"title": "Url", "type": "string"}}, "title": "Criminal Search Details", "type": "object"}, "IgnoredItem": {"description": "Ignored items reasons, source and details.", "properties": {"details": {"$ref": "#/components/schemas/definitions-DetailsItem"}, "ignored_reason": {"title": "Ignored Reason", "type": "string"}, "source": {"title": "Source", "type": "string"}}, "required": ["source", "details", "ignored_reason"], "title": "Criminal Search Details", "type": "object"}}, "description": "Details schema for criminal search report.", "properties": {"boletin_cba": {"items": {"$ref": "#/components/schemas/definitions-DetailsItem"}, "title": "Boletin Cba", "type": "array"}, "boletin_corr": {"items": {"$ref": "#/components/schemas/definitions-DetailsItem"}, "title": "Boletin Corr", "type": "array"}, "boletin_mis": {"items": {"$ref": "#/components/schemas/definitions-DetailsItem"}, "title": "Boletin Mis", "type": "array"}, "boletin_neg": {"items": {"$ref": "#/components/schemas/definitions-DetailsItem"}, "title": "Boletin Neg", "type": "array"}, "boletin_neuq": {"items": {"$ref": "#/components/schemas/definitions-DetailsItem"}, "title": "Boletin Neuq", "type": "array"}, "boletin_pba": {"items": {"$ref": "#/components/schemas/definitions-DetailsItem"}, "title": "Boletin Pba", "type": "array"}, "boletin_pch": {"items": {"$ref": "#/components/schemas/definitions-DetailsItem"}, "title": "Boletin Pch", "type": "array"}, "boletin_rarg": {"items": {"$ref": "#/components/schemas/definitions-DetailsItem"}, "title": "Boletin Rarg", "type": "array"}, "boletin_rios": {"items": {"$ref": "#/components/schemas/definitions-DetailsItem"}, "title": "Boletin Rios", "type": "array"}, "boletin_salt": {"items": {"$ref": "#/components/schemas/definitions-DetailsItem"}, "title": "Boletin Salt", "type": "array"}, "boletin_scz": {"items": {"$ref": "#/components/schemas/definitions-DetailsItem"}, "title": "Boletin Scz", "type": "array"}, "ignored_items": {"items": {"$ref": "#/components/schemas/IgnoredItem"}, "title": "Ignored Items", "type": "array"}, "message": {"title": "Message", "type": "string"}, "sentencias_cij": {"items": {"$ref": "#/components/schemas/definitions-DetailsItem"}, "title": "Sentencias Cij", "type": "array"}}, "title": "Criminal Search Details", "type": "object"}, "JudicialRecord": {"description": "Matched judicial record schema for federal inmates report.", "properties": {"age": {"title": "Age", "type": "integer"}, "court": {"title": "Court", "type": "string"}, "crime": {"title": "Crime", "type": "string"}, "date_of_final_sentence": {"title": "Date Of Final Sentence", "type": "string"}, "days_imprisonment": {"title": "Days Imprisonment", "type": "integer"}, "dob": {"title": "Dob", "type": "string"}, "entry_date": {"title": "Entry Date", "type": "string"}, "forenames": {"title": "Forenames", "type": "string"}, "id_state_of_birth": {"title": "Id State Of Birth", "type": "string"}, "id_state_unit": {"title": "Id State Unit", "type": "string"}, "imprisonment_type": {"title": "Imprisonment Type", "type": "string"}, "jurisdiction": {"title": "Jurisdiction", "type": "string"}, "marital_status": {"title": "Marital Status", "type": "string"}, "months_imprisonment": {"title": "Months Imprisonment", "type": "integer"}, "nationality": {"title": "Nationality", "type": "string"}, "number": {"title": "Number", "type": "string"}, "procedural_status": {"title": "Procedural Status", "type": "string"}, "profession": {"title": "Profession", "type": "string"}, "sex": {"title": "Sex", "type": "string"}, "state_of_birth": {"title": "State Of Birth", "type": "string"}, "state_unit": {"title": "State Unit", "type": "string"}, "subgroup": {"title": "Subgroup", "type": "string"}, "surnames": {"title": "Surnames", "type": "string"}, "unit": {"title": "Unit", "type": "string"}, "years_imprisonment": {"title": "Years Imprisonment", "type": "integer"}}, "title": "Federal Inmates Details", "type": "object"}, "ar_federal_inmates": {"definitions": {"JudicialRecord": {"description": "Matched judicial record schema for federal inmates report.", "properties": {"age": {"title": "Age", "type": "integer"}, "court": {"title": "Court", "type": "string"}, "crime": {"title": "Crime", "type": "string"}, "date_of_final_sentence": {"title": "Date Of Final Sentence", "type": "string"}, "days_imprisonment": {"title": "Days Imprisonment", "type": "integer"}, "dob": {"title": "Dob", "type": "string"}, "entry_date": {"title": "Entry Date", "type": "string"}, "forenames": {"title": "Forenames", "type": "string"}, "id_state_of_birth": {"title": "Id State Of Birth", "type": "string"}, "id_state_unit": {"title": "Id State Unit", "type": "string"}, "imprisonment_type": {"title": "Imprisonment Type", "type": "string"}, "jurisdiction": {"title": "Jurisdiction", "type": "string"}, "marital_status": {"title": "Marital Status", "type": "string"}, "months_imprisonment": {"title": "Months Imprisonment", "type": "integer"}, "nationality": {"title": "Nationality", "type": "string"}, "number": {"title": "Number", "type": "string"}, "procedural_status": {"title": "Procedural Status", "type": "string"}, "profession": {"title": "Profession", "type": "string"}, "sex": {"title": "Sex", "type": "string"}, "state_of_birth": {"title": "State Of Birth", "type": "string"}, "state_unit": {"title": "State Unit", "type": "string"}, "subgroup": {"title": "Subgroup", "type": "string"}, "surnames": {"title": "Surnames", "type": "string"}, "unit": {"title": "Unit", "type": "string"}, "years_imprisonment": {"title": "Years Imprisonment", "type": "integer"}}, "title": "Federal Inmates Details", "type": "object"}}, "description": "Details schema for federal inmates report.", "properties": {"dob": {"title": "Dob", "type": "string"}, "forenames": {"title": "Forenames", "type": "string"}, "items": {"items": {"$ref": "#/components/schemas/JudicialRecord"}, "title": "Items", "type": "array"}, "message": {"title": "Message", "type": "string"}, "surnames": {"title": "Surnames", "type": "string"}}, "required": ["surnames", "forenames", "dob", "items"], "title": "Federal Inmates Details", "type": "object"}, "FileInformation": {"description": "Datos causales.", "properties": {"court": {"title": "Court", "type": "string"}, "crime": {"title": "Crime", "type": "string"}, "date": {"title": "Date", "type": "string"}, "details": {"title": "Details", "type": "string"}, "file_number": {"title": "File Number", "type": "string"}, "location": {"title": "Location", "type": "string"}, "state": {"title": "State", "type": "string"}, "state_id": {"title": "State Id", "type": "string"}}, "title": "National Fugitives Details", "type": "object"}, "PersonalData": {"description": "Person information.", "properties": {"alias": {"title": "Alias", "type": "string"}, "dob": {"title": "Dob", "type": "string"}, "document_id": {"title": "Document Id", "type": "string"}, "document_type": {"title": "Document Type", "type": "string"}, "forenames": {"title": "Forenames", "type": "string"}, "nationality": {"title": "Nationality", "type": "string"}, "place_of_birth": {"title": "Place Of Birth", "type": "string"}, "presumed_age": {"title": "Presumed Age", "type": "string"}, "sex": {"title": "Sex", "type": "string"}, "surnames": {"title": "Surnames", "type": "string"}}, "title": "National Fugitives Details", "type": "object"}, "Record": {"description": "Record match information.", "properties": {"file_information": {"$ref": "#/components/schemas/FileInformation"}, "personal_data": {"$ref": "#/components/schemas/PersonalData"}, "source": {"enum": ["conarc", "rnr"], "title": "Source", "type": "string"}}, "required": ["file_information", "personal_data", "source"], "title": "National Fugitives Details", "type": "object"}, "ar_national_fugitives": {"definitions": {"FileInformation": {"description": "Datos causales.", "properties": {"court": {"title": "Court", "type": "string"}, "crime": {"title": "Crime", "type": "string"}, "date": {"title": "Date", "type": "string"}, "details": {"title": "Details", "type": "string"}, "file_number": {"title": "File Number", "type": "string"}, "location": {"title": "Location", "type": "string"}, "state": {"title": "State", "type": "string"}, "state_id": {"title": "State Id", "type": "string"}}, "title": "National Fugitives Details", "type": "object"}, "PersonalData": {"description": "Person information.", "properties": {"alias": {"title": "Alias", "type": "string"}, "dob": {"title": "Dob", "type": "string"}, "document_id": {"title": "Document Id", "type": "string"}, "document_type": {"title": "Document Type", "type": "string"}, "forenames": {"title": "Forenames", "type": "string"}, "nationality": {"title": "Nationality", "type": "string"}, "place_of_birth": {"title": "Place Of Birth", "type": "string"}, "presumed_age": {"title": "Presumed Age", "type": "string"}, "sex": {"title": "Sex", "type": "string"}, "surnames": {"title": "Surnames", "type": "string"}}, "title": "National Fugitives Details", "type": "object"}, "Record": {"description": "Record match information.", "properties": {"file_information": {"$ref": "#/components/schemas/FileInformation"}, "personal_data": {"$ref": "#/components/schemas/PersonalData"}, "source": {"enum": ["conarc", "rnr"], "title": "Source", "type": "string"}}, "required": ["file_information", "personal_data", "source"], "title": "National Fugitives Details", "type": "object"}}, "description": "Schema for national fugitives matches.", "properties": {"dob": {"title": "Dob", "type": "string"}, "document_id": {"title": "Document Id", "type": "string"}, "forenames": {"title": "Forenames", "type": "string"}, "items": {"items": {"$ref": "#/components/schemas/Record"}, "title": "Items", "type": "array"}, "message": {"title": "Message", "type": "string"}, "surnames": {"title": "Surnames", "type": "string"}}, "required": ["surnames", "forenames", "items"], "title": "National Fugitives Details", "type": "object"}, "ar_sanctions": {"description": "Sanctions details schema.", "properties": {"found_matches": {"default": false, "title": "Found Matches", "type": "boolean"}, "ignored_items": {"items": {"type": "object"}, "title": "Ignored Items", "type": "array"}, "matches": {"additionalProperties": {"items": {"type": "object"}, "type": "array"}, "title": "Matches", "type": "object"}, "message": {"title": "Message", "type": "string"}}, "title": "Sanctions Details", "type": "object"}, "ar_name_check": {"description": "Details schema for the name_check report.", "properties": {"full_name": {"title": "Full Name", "type": "string"}, "message": {"title": "Message", "type": "string"}, "name_fragment_check": {"title": "Name Fragment Check", "type": "boolean"}, "name_score_min": {"title": "Name Score Min", "type": "number"}, "score": {"title": "Score", "type": "number"}}, "required": ["score", "full_name", "name_fragment_check", "name_score_min"], "title": "Name Check Details", "type": "object"}, "ar_news_search": {"definitions": {"Summary": {"description": "Summary schema for the news_search report.", "properties": {"relevant": {"description": "Whether the summary is relevant.", "title": "Relevant", "type": "boolean"}, "summary": {"description": "Summary of the news article.", "title": "Summary", "type": "string"}, "web_page_url": {"description": "URL of the news article.", "title": "Web Page Url", "type": "string"}}, "title": "News Search Details", "type": "object"}}, "description": "Details schema for the news_search report.", "properties": {"full_name": {"description": "Query used to search for the person.", "title": "Full Name", "type": "string"}, "message": {"title": "Message", "type": "string"}, "summaries": {"description": "List of AI generated summaries.", "items": {"$ref": "#/components/schemas/Summary"}, "title": "Summaries", "type": "array"}}, "title": "News Search Details", "type": "object"}, "ar_one_of": {"oneOf": [{"$ref": "#/components/schemas/ar_id_status"}, {"$ref": "#/components/schemas/ar_criminal_search"}, {"$ref": "#/components/schemas/ar_federal_inmates"}, {"$ref": "#/components/schemas/ar_national_fugitives"}, {"$ref": "#/components/schemas/ar_sanctions"}, {"$ref": "#/components/schemas/ar_name_check"}, {"$ref": "#/components/schemas/ar_news_search"}]}, "list_pipeline_schema": {"title": "List Pipelines Schema", "type": "object", "properties": {"data": {"type": "array", "items": {"type": "object", "properties": {"name": {"type": "string", "example": "test-pipeline"}, "country_code": {"type": "string", "example": "BR"}, "reports_enabled": {"type": "array", "items": {"type": "string", "example": "name_check"}}, "reports_settings": {"description": "Additional report settings", "type": "object"}, "alias": {"type": "string"}, "description": {"type": "string"}, "pipeline_id": {"type": "string", "example": "0ujsszwN8NRY24YaXiTIE2VWDTS"}, "created_at": {"type": "string", "example": "2020-11-01T12:06:42.438815"}, "updated_at": {"type": "string", "example": "2020-11-01T12:06:42.438815"}}}}, "next_batch": {"type": "string", "example": "AQICAHgk..."}}}, "create_pipeline_schema": {"title": "Create Pipeline Schema", "type": "object", "required": ["name", "country_code", "reports_enabled"], "properties": {"name": {"description": "Unique name to identify the pipeline\n", "type": "string", "example": "test-pipeline"}, "country_code": {"description": "2 letter country code.\n", "type": "string", "example": "BR"}, "reports_enabled": {"description": "List of reports enabled for the pipeline.\n", "type": "array", "items": {"type": "string", "example": "name_check"}}, "alias": {"description": "User friendly alias for the pipeline.\n", "type": "string", "example": "Drivers Test 2"}, "description": {"description": "A short description about this pipeline.\n", "type": "string"}, "reports_settings": {"description": "Additional report settings", "type": "object", "additionalProperties": {"type": "object", "additionalProperties": {}}}}}, "create_pipeline_response_schema": {"title": "Create Pipeline Schema", "type": "object", "description": "Details of the created pipeline", "properties": {"pipeline_id": {"description": "Automatic ID\n", "example": "0ujsszwN8NRY24YaXiTIE2VWDTS"}, "name": {"description": "Unique name to identify the pipeline\n", "type": "string", "example": "test-pipeline"}, "country_code": {"description": "2 letter country code.\n", "type": "string", "example": "BR"}, "reports_enabled": {"description": "List of reports enabled for the pipeline.\n", "type": "array", "items": {"type": "string", "example": "name_check"}}, "alias": {"description": "User friendly alias for the pipeline.\n", "type": "string", "example": "Drivers Test 2"}, "description": {"description": "A short description about this pipeline.\n", "type": "string"}, "reports_settings": {"description": "Additional report settings", "type": "object"}}}, "update_pipeline_schema": {"title": "Update Pipeline Schema", "type": "object", "properties": {"name": {"description": "Unique name to identify the pipeline\n", "type": "string", "example": "test-pipeline"}, "reports_enabled": {"description": "List of reports enabled for the pipeline.\n", "type": "array", "items": {"type": "string", "example": "test_report"}}, "alias": {"description": "User friendly alias for the pipeline.\n", "type": "string", "example": "Drivers Test 2"}, "description": {"description": "A short description about this pipeline.\n", "type": "string"}, "reports_settings": {"description": "Additional report settings", "type": "object", "additionalProperties": {"type": "object", "additionalProperties": {}}}}}, "get_pipeline_schema_response_schema": {"title": "Get Pipeline Schema", "type": "object", "properties": {"title": {"type": "string", "example": "Person"}, "description": {"type": "string", "example": "Person schema to use for a report"}, "type": {"type": "string", "example": "object"}, "properties": {"type": "object", "properties": {"document_id": {"type": "object", "properties": {"type": {"type": "string", "example": "string"}}}, "city_locode": {"type": "object", "properties": {"type": {"type": "string", "example": "string"}}}, "pipeline": {"type": "object", "properties": {"ref": {"type": "string", "example": "#/definitions/Pipeline"}}}}}, "required": {"type": "array", "example": ["document_id", "city_locode", "pipeline"]}, "definitions": {"type": "object", "properties": {"Pipeline": {"type": "object", "properties": {"title": {"type": "string", "example": "Pipeline"}, "type": {"type": "string", "example": "string"}, "properties": {"type": "object", "properties": {"name": {"type": "object", "properties": {"title": {"type": "string", "example": "Name"}, "enum": {"type": "array", "example": ["test-pipeline"]}}}}}, "required": {"type": "array", "example": ["name"]}}}}}}}, "ValuesetDetailsSchema": {"description": "Valueset details schema.", "properties": {"description": {"title": "Description", "type": "string"}, "value": {"title": "Value", "type": "string"}}, "required": ["value"], "title": "Valueset data item", "type": "object"}, "Valuesets_Details_Response": {"definitions": {"ValuesetDetailsSchema": {"description": "Valueset details schema.", "properties": {"description": {"title": "Description", "type": "string"}, "value": {"title": "Value", "type": "string"}}, "required": ["value"], "title": "Valueset data item", "type": "object"}}, "description": "Valueset details response schema.", "properties": {"data": {"items": {"$ref": "#/components/schemas/ValuesetDetailsSchema"}, "title": "Data", "type": "array"}}, "required": ["data"], "title": "Valuesets Details Response", "type": "object"}, "configure_webhook_schema": {"title": "Configure Webhook Mapping", "type": "object", "required": ["webhook_url"], "properties": {"webhook_url": {"description": "URL for webhook POST requests to receive folder finished notifications.\n", "type": "string", "example": "https://yourwebhook.example.com/path/to/webhook"}, "webhook_headers": {"description": "Optional headers to perform POST request.", "type": "object"}}}}}, "tags": [{"name": "Persons", "description": "Manage persons - Create, get data and status, update, etc."}, {"name": "Reports", "description": "Manage person's reports."}, {"name": "Report details", "description": "Retrieve details per report"}, {"name": "Pipelines", "description": "Manage pipelines - List, create, get data and status, update, etc."}, {"name": "Valuesets", "description": "Retrieve valuesets."}, {"name": "Webhooks", "description": "Manage webhooks - Setup a new webhook to receive folder finished events."}], "security": [{"ApiKeyAuth": []}]}