Case manaegment - change status

The following endpoint allows to change the status of the case via API. If you would like to find out more information about possible status changes check our guide Risk assessment process.

Start

POSThttps://api.app.gatenox.com/api/v1/verifications/{verification_id}/state/start

Path parameters

verification_id*string

Example: "47f0bf5c-5329-4bd8-ad24-2603b697e5e7"

Body

Response

200400401

OK

Body

application/json

verificationPOST_apiv1verificationsverification_idstatestart_response_200_verification (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.app.gatenox.com/api/v1/verifications/{verification_id}/state/start', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

200401

{
  "verification": {
    "id": "text",
    "status": "text",
    "revision_timestamps": [
      0
    ],
    "created_at": "text",
    "updated_at": "text",
    "company_name": "text",
    "company_number": "text",
    "access_type": "text",
    "last_data_update": "text",
    "verification_type": "text",
    "company_jurisdiction": {
      "id": "text",
      "code": "text",
      "name": "text",
      "country": "text",
      "full_name": "text"
    },
    "verifier": {
      "id": "text",
      "name": "text",
      "referral": "text",
      "description": "text",
      "logo": {
        "filename": "text",
        "filesize": 0,
        "mime": "text",
        "urls": {
          "thumb": "text",
          "medium": "text",
          "original": "text"
        }
      }
    }
  }
}

Request Risk Score Update

POSThttps://api.app.gatenox.com/api/v1/verifications/{verification_id}/state/request_risk_score_update

Path parameters

verification_id*string

Example: "81e38c0b-66c9-4f69-82c2-8688ea033e75"

Body

Response

default

default

Body

text/plain

string

Request

JavaScriptCurlPython

const response = await fetch('https://api.app.gatenox.com/api/v1/verifications/{verification_id}/state/request_risk_score_update', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

default

text

Cancel Risk Score Update

POSThttps://api.app.gatenox.com/api/v1/verifications/{verification_id}/state/cancel_risk_score_update

Path parameters

verification_id*string

Example: "81e38c0b-66c9-4f69-82c2-8688ea033e75"

Body

Response

default

default

Body

text/plain

string

Request

JavaScriptCurlPython

const response = await fetch('https://api.app.gatenox.com/api/v1/verifications/{verification_id}/state/cancel_risk_score_update', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

default

text

Request Data Update

POSThttps://api.app.gatenox.com/api/v1/verifications/{verification_id}/state/request_data_update

Path parameters

verification_id*string

Example: "c859559c-1f21-427b-81a8-980ba52e4ca4"

Query parameters

Body

Response

200

OK

Body

application/json

verificationPOST_apiv1verificationsverification_idstaterequest_data_update_response_200_verification (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.app.gatenox.com/api/v1/verifications/{verification_id}/state/request_data_update', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

200

{
  "verification": {
    "id": "text",
    "status": "text",
    "revision_timestamps": [
      0
    ],
    "created_at": "text",
    "updated_at": "text",
    "company_name": "text",
    "company_number": "text",
    "access_type": "text",
    "last_data_update": "text",
    "verification_type": "text",
    "company_jurisdiction": {
      "id": "text",
      "code": "text",
      "name": "text",
      "country": "text",
      "full_name": "text"
    },
    "verifier": {
      "id": "text",
      "name": "text",
      "referral": "text",
      "description": "text",
      "logo": {
        "filename": "text",
        "filesize": 0,
        "mime": "text",
        "urls": {
          "thumb": "text",
          "medium": "text",
          "original": "text"
        }
      }
    }
  }
}

Cancel Data Update

POSThttps://api.app.gatenox.com/api/v1/verifications/{verification_id}/state/cancel_data_update

Path parameters

verification_id*string

Example: "df786f41-241b-43bc-a4b9-0eb90f7be8e9"

Body

Response

200422

OK

Headers

Body

application/json

verificationPOST_apiv1verificationsverification_idstatecancel_data_update_response_200_verification (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.app.gatenox.com/api/v1/verifications/{verification_id}/state/cancel_data_update', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

200422

{
  "verification": {
    "id": "text",
    "status": "text",
    "revision_timestamps": [
      0
    ],
    "created_at": "text",
    "updated_at": "text",
    "company_name": "text",
    "company_number": "text",
    "access_type": "text",
    "last_data_update": "text",
    "verification_type": "text",
    "company_jurisdiction": {
      "id": "text",
      "code": "text",
      "name": "text",
      "country": "text",
      "full_name": "text"
    },
    "verifier": {
      "id": "text",
      "name": "text",
      "referral": "text",
      "description": "text",
      "logo": {
        "filename": "text",
        "filesize": 0,
        "mime": "text",
        "urls": {
          "thumb": "text",
          "medium": "text",
          "original": "text"
        }
      }
    }
  }
}

QA

POSThttps://api.app.gatenox.com/api/v1/verifications/{verification_id}/state/qa

Path parameters

verification_id*string

Example: "2d926af7-2397-4296-865a-4e7cd93017c0"

Body

multipart/form-data

assessmentstring

enum: risk_low, risk_medium, risk_high

Example: "risk_low"

assessment_commentstring

string

Example: "Lorem ipsum dolor sit amet"

Response

200401422

OK

Body

application/json

verificationPOST_apiv1verificationsverification_idstateqa_response_200_verification (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.app.gatenox.com/api/v1/verifications/{verification_id}/state/qa', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200401

{
  "verification": {
    "id": "text",
    "company_name": "text",
    "company_number": "text",
    "status": "text",
    "assessment": "text",
    "revision_timestamps": [
      0
    ],
    "created_at": "text",
    "updated_at": "text",
    "assessment_comment": "text",
    "company_jurisdiction": {
      "id": "text",
      "code": "text",
      "name": "text",
      "country": "text",
      "full_name": "text"
    }
  }
}

Back to Compliance

POSThttps://api.app.gatenox.com/api/v1/verifications/{verification_id}/state/back_to_compliance

Path parameters

verification_id*string

Example: "2d926af7-2397-4296-865a-4e7cd93017c0"

Body

multipart/form-data

qa_commentstring

string

Example: "Lorem ipsum dolor sit amet"

Response

200401422

OK

Body

application/json

verificationPOST_apiv1verificationsverification_idstateback_to_compliance_response_200_verification (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.app.gatenox.com/api/v1/verifications/{verification_id}/state/back_to_compliance', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200401422

{
  "verification": {
    "id": "text",
    "company_name": "text",
    "company_number": "text",
    "status": "text",
    "assessment": "text",
    "revision_timestamps": [
      0
    ],
    "created_at": "text",
    "updated_at": "text",
    "qa_comment": "text",
    "assessment_comment": "text",
    "company_jurisdiction": {
      "id": "text",
      "code": "text",
      "name": "text",
      "country": "text",
      "full_name": "text"
    }
  }
}

Complete

POSThttps://api.app.gatenox.com/api/v1/verifications/{verification_id}/state/complete

Path parameters

verification_id*string

Example: "2d926af7-2397-4296-865a-4e7cd93017c0"

Body

multipart/form-data

assessmentstring

enum: risk_low, risk_medium, risk_high

Example: "risk_medium"

assessment_commentstring

string

Example: "Lorem ipsum dolor sit amet"

qa_commentstring

string

Example: "Lorem ipsum dolor sit amet"

Response

200

OK

Body

application/json

verificationPOST_apiv1verificationsverification_idstatecomplete_response_200_verification (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.app.gatenox.com/api/v1/verifications/{verification_id}/state/complete', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "verification": {
    "id": "text",
    "company_name": "text",
    "company_number": "text",
    "status": "text",
    "assessment": "text",
    "revision_timestamps": [
      0
    ],
    "created_at": "text",
    "updated_at": "text",
    "qa_comment": "text",
    "assessment_comment": "text",
    "company_jurisdiction": {
      "id": "text",
      "code": "text",
      "name": "text",
      "country": "text",
      "full_name": "text"
    }
  }
}

Rejected

POSThttps://api.app.gatenox.com/api/v1/verifications/{verification_id}/state/rejected

Path parameters

verification_id*string

Example: "2d92fc77-c14c-4c6b-bed9-acfe015696ca"

Body

multipart/form-data

rejection_commentstring

Example: "Lorem ipsum dolor sit amet"

Response

200

OK

Body

application/json

verificationPOST_apiv1verificationsverification_idstaterejected_response_200_verification (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.app.gatenox.com/api/v1/verifications/{verification_id}/state/rejected', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "verification": {
    "id": "text",
    "customer_id": "text",
    "status": "text",
    "entity_name": "text",
    "entity_identifier": "text",
    "entity_contact_email": "text",
    "revision_timestamps": [
      0
    ],
    "created_at": "text",
    "updated_at": "text",
    "company_name": "text",
    "company_number": "text",
    "access_type": "text",
    "last_data_update": "text",
    "verification_type": "text",
    "rejection_comment": "text",
    "metadata": {
      "section_ubos_completed_qa": false,
      "section_files_completed_qa": false,
      "section_details_completed_qa": false,
      "section_structure_completed_qa": false,
      "section_ubos_completed_verification": false,
      "section_files_completed_verification": false,
      "section_details_completed_verification": false,
      "section_identified_issues_completed_qa": false,
      "section_structure_completed_verification": false,
      "section_business_representatives_completed_qa": false,
      "section_identified_issues_completed_verification": false,
      "section_business_representatives_completed_verification": false
    },
    "external_risk_score": {
      "id": "text",
      "created_at": "text",
      "updated_at": "text",
      "verification_id": "text"
    }
  }
}

Reopen

POSThttps://api.app.gatenox.com/api/v1/verifications/{verification_id}/state/reopen

Path parameters

verification_id*string

Example: "2d926af7-2397-4296-865a-4e7cd93017c0"

Body

Response

200

OK

Body

application/json

verificationPOST_apiv1verificationsverification_idstatereopen_response_200_verification (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.app.gatenox.com/api/v1/verifications/{verification_id}/state/reopen', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

200

{
  "verification": {
    "id": "text",
    "company_name": "text",
    "company_number": "text",
    "status": "text",
    "assessment": "text",
    "revision_timestamps": [
      0
    ],
    "created_at": "text",
    "updated_at": "text",
    "qa_comment": "text",
    "assessment_comment": "text",
    "company_jurisdiction": {
      "id": "text",
      "code": "text",
      "name": "text",
      "country": "text",
      "full_name": "text"
    }
  }
}