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

post
Authorizations
Path parameters
verification_idstringRequiredExample: 47f0bf5c-5329-4bd8-ad24-2603b697e5e7
Body
Responses
200
OK
application/json
post
POST /api/v1/verifications/{verification_id}/state/start HTTP/1.1
Host: api.app.gatenox.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "verification": {
    "id": "df786f41-241b-43bc-a4b9-0eb90f7be8e9",
    "status": "in_progress",
    "revision_timestamps": [
      1693315960
    ],
    "created_at": "2023-10-06T14:06:21.508Z",
    "updated_at": "2023-10-06T14:06:21.508Z",
    "company_name": "Full Data",
    "company_number": "13412213",
    "access_type": "verifier_compliance_officer",
    "last_data_update": "2023-08-29T13:32:40.000Z",
    "verification_type": "recurring",
    "qa_comment": null,
    "assessment_comment": null,
    "assessment": null,
    "reopen_at": null,
    "company_jurisdiction": {
      "id": "f728e115-9301-47e2-996c-0c8d0e39fb10",
      "code": "gb",
      "name": "United Kingdom",
      "country": "United Kingdom",
      "full_name": "United Kingdom"
    },
    "assigned_to": null,
    "verifier": {
      "id": "e636733a-b8dd-4ebd-ada2-f08db8582b16",
      "name": "Gatenox Partner",
      "referral": "L9DZE3TU",
      "description": "",
      "logo": {
        "filename": "Zrzut ekranu 2023-03-22 o 21.29.26.png",
        "filesize": 427181,
        "mime": "image/png",
        "urls": {
          "thumb": "https://gatenox-tests.s3.eu-north-1.amazonaws.com/public/thumbnails/336b18230664c2d3fadd4fcd4432879e.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAXSZUOLTJPRNABGEK%2F20231010%2Feu-north-1%2Fs3%2Faws4_request&X-Amz-Date=20231010T123419Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=92bee5d3e6e861f03cfeea34fc51ebdf8d29df78e43efa4846f379a721f4c7ac",
          "medium": "https://gatenox-tests.s3.eu-north-1.amazonaws.com/public/thumbnails/b1a63721ecbbcadbbba213907bc76e59.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAXSZUOLTJPRNABGEK%2F20231010%2Feu-north-1%2Fs3%2Faws4_request&X-Amz-Date=20231010T123419Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=4f229b0659011f1ac71176e7142380cdd77c079b1c9b83f691d5e7f701aef0be",
          "original": "https://gatenox-tests.s3.eu-north-1.amazonaws.com/public/c87350b9f92cff7b5b5976b9e75fa33a.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAXSZUOLTJPRNABGEK%2F20231010%2Feu-north-1%2Fs3%2Faws4_request&X-Amz-Date=20231010T123419Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=981e583cee886e0ce052cc94a1fc52c4cb28458f8aa7bdef6500409cd88142c8"
        }
      }
    }
  }
}

Request Risk Score Update

post
Authorizations
Path parameters
verification_idstringRequiredExample: 81e38c0b-66c9-4f69-82c2-8688ea033e75
Body
Responses
default
default
text/plain
Responsestring
post
POST /api/v1/verifications/{verification_id}/state/request_risk_score_update HTTP/1.1
Host: api.app.gatenox.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
default

default

{

    "verification": {

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

        "customer_id": "",

        "status": "recalculate_risk_score",

        "entity_name": "Test verification process",

        "entity_identifier": "123123123",

        "entity_contact_email": "[email protected]",

        "revision_timestamps": [

            1725877830

        ],

        "created_at": "2024-09-09T10:09:58.616Z",

        "updated_at": "2024-09-09T10:41:13.549Z",

        "company_name": "Test verification process",

        "company_number": "123123123",

        "access_type": "verifier_compliance_officer",

        "last_data_update": "2024-09-09T10:30:30.000Z",

        "verification_type": "primary",

        "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

        },

        "completeness_profile_id": "b80743bc-bffe-48b1-9289-cd6aad0ab854",

        "external_risk_score": {

            "id": "dd6370af-e50f-4092-ad94-f12079d949ef",

            "created_at": "2024-09-09T10:35:55.113Z",

            "updated_at": "2024-09-09T10:35:55.113Z",

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

        }

    }

}

Cancel Risk Score Update

post
Authorizations
Path parameters
verification_idstringRequiredExample: 81e38c0b-66c9-4f69-82c2-8688ea033e75
Body
Responses
default
default
text/plain
Responsestring
post
POST /api/v1/verifications/{verification_id}/state/cancel_risk_score_update HTTP/1.1
Host: api.app.gatenox.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
default

default

{

    "verification": {

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

        "customer_id": "",

        "status": "in_progress",

        "entity_name": "Test verification process",

        "entity_identifier": "123123123",

        "entity_contact_email": "[email protected]",

        "revision_timestamps": [

            1725877830

        ],

        "created_at": "2024-09-09T10:09:58.616Z",

        "updated_at": "2024-09-09T10:41:13.549Z",

        "company_name": "Test verification process",

        "company_number": "123123123",

        "access_type": "verifier_compliance_officer",

        "last_data_update": "2024-09-09T10:30:30.000Z",

        "verification_type": "primary",

        "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

        },

        "completeness_profile_id": "b80743bc-bffe-48b1-9289-cd6aad0ab854",

        "external_risk_score": {

            "id": "dd6370af-e50f-4092-ad94-f12079d949ef",

            "created_at": "2024-09-09T10:35:55.113Z",

            "updated_at": "2024-09-09T10:35:55.113Z",

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

        }

    }

}

Request Data Update

post
Authorizations
Path parameters
verification_idstringRequiredExample: c859559c-1f21-427b-81a8-980ba52e4ca4
Query parameters
completeness_profile_idstringOptionalExample: b80743bc-bffe-48b1-9289-cd6aad0ab854
Body
Responses
200
OK
application/json
post
POST /api/v1/verifications/{verification_id}/state/request_data_update HTTP/1.1
Host: api.app.gatenox.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "verification": {
    "id": "df786f41-241b-43bc-a4b9-0eb90f7be8e9",
    "status": "data_update_requested",
    "revision_timestamps": [
      1693315960
    ],
    "created_at": "2023-10-06T14:06:21.508Z",
    "updated_at": "2023-10-10T12:36:56.261Z",
    "company_name": "Full Data",
    "company_number": "13412213",
    "access_type": "verifier_compliance_officer",
    "last_data_update": "2023-08-29T13:32:40.000Z",
    "verification_type": "recurring",
    "qa_comment": null,
    "assessment_comment": null,
    "assessment": null,
    "reopen_at": null,
    "company_jurisdiction": {
      "id": "f728e115-9301-47e2-996c-0c8d0e39fb10",
      "code": "gb",
      "name": "United Kingdom",
      "country": "United Kingdom",
      "full_name": "United Kingdom"
    },
    "assigned_to": null,
    "verifier": {
      "id": "e636733a-b8dd-4ebd-ada2-f08db8582b16",
      "name": "Gatenox Partner",
      "referral": "L9DZE3TU",
      "description": "",
      "logo": {
        "filename": "Zrzut ekranu 2023-03-22 o 21.29.26.png",
        "filesize": 427181,
        "mime": "image/png",
        "urls": {
          "thumb": "https://gatenox-tests.s3.eu-north-1.amazonaws.com/public/thumbnails/336b18230664c2d3fadd4fcd4432879e.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAXSZUOLTJPRNABGEK%2F20231010%2Feu-north-1%2Fs3%2Faws4_request&X-Amz-Date=20231010T123724Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=d80cf93bbc5fbd9305581f26c8ee91ffccebe616c679e2820b08bcddd21a2c6d",
          "medium": "https://gatenox-tests.s3.eu-north-1.amazonaws.com/public/thumbnails/b1a63721ecbbcadbbba213907bc76e59.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAXSZUOLTJPRNABGEK%2F20231010%2Feu-north-1%2Fs3%2Faws4_request&X-Amz-Date=20231010T123724Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=74c2e2a57e66578aad3696d063799972245d8c6cd7d6fa70654fa436c3757907",
          "original": "https://gatenox-tests.s3.eu-north-1.amazonaws.com/public/c87350b9f92cff7b5b5976b9e75fa33a.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAXSZUOLTJPRNABGEK%2F20231010%2Feu-north-1%2Fs3%2Faws4_request&X-Amz-Date=20231010T123724Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=0f90818c1758a9661850eaa67bb578613f1c3a81b632452c6b705e06ce3316d0"
        }
      }
    }
  }
}

Cancel Data Update

post
Authorizations
Path parameters
verification_idstringRequiredExample: df786f41-241b-43bc-a4b9-0eb90f7be8e9
Body
Responses
200
OK
application/json
post
POST /api/v1/verifications/{verification_id}/state/cancel_data_update HTTP/1.1
Host: api.app.gatenox.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "verification": {
    "id": "df786f41-241b-43bc-a4b9-0eb90f7be8e9",
    "status": "in_progress",
    "revision_timestamps": [
      1693315960
    ],
    "created_at": "2023-10-06T14:06:21.508Z",
    "updated_at": "2023-10-10T12:36:56.261Z",
    "company_name": "Full Data",
    "company_number": "13412213",
    "access_type": "verifier_compliance_officer",
    "last_data_update": "2023-08-29T13:32:40.000Z",
    "verification_type": "recurring",
    "qa_comment": null,
    "assessment_comment": null,
    "assessment": null,
    "reopen_at": null,
    "company_jurisdiction": {
      "id": "f728e115-9301-47e2-996c-0c8d0e39fb10",
      "code": "gb",
      "name": "United Kingdom",
      "country": "United Kingdom",
      "full_name": "United Kingdom"
    },
    "assigned_to": null,
    "verifier": {
      "id": "e636733a-b8dd-4ebd-ada2-f08db8582b16",
      "name": "Gatenox Partner",
      "referral": "L9DZE3TU",
      "description": "",
      "logo": {
        "filename": "Zrzut ekranu 2023-03-22 o 21.29.26.png",
        "filesize": 427181,
        "mime": "image/png",
        "urls": {
          "thumb": "https://gatenox-tests.s3.eu-north-1.amazonaws.com/public/thumbnails/336b18230664c2d3fadd4fcd4432879e.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAXSZUOLTJPRNABGEK%2F20231010%2Feu-north-1%2Fs3%2Faws4_request&X-Amz-Date=20231010T123827Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=45f78a78a44fb24d58db2e33df0eab8e306c5c7851b3c175527b0dce0473004a",
          "medium": "https://gatenox-tests.s3.eu-north-1.amazonaws.com/public/thumbnails/b1a63721ecbbcadbbba213907bc76e59.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAXSZUOLTJPRNABGEK%2F20231010%2Feu-north-1%2Fs3%2Faws4_request&X-Amz-Date=20231010T123827Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=3c7d691df7c9297ffee515592381c935eadddf6a9247f5448ba1d951c051dcfc",
          "original": "https://gatenox-tests.s3.eu-north-1.amazonaws.com/public/c87350b9f92cff7b5b5976b9e75fa33a.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAXSZUOLTJPRNABGEK%2F20231010%2Feu-north-1%2Fs3%2Faws4_request&X-Amz-Date=20231010T123827Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=040228e9b6dbdc8646fd2bc64ee3441a74234817f205bab6e4a8263f073e6b2b"
        }
      }
    }
  }
}

QA

post
Authorizations
Path parameters
verification_idstringRequiredExample: 2d926af7-2397-4296-865a-4e7cd93017c0
Body
assessmentstringOptional

enum: risk_low, risk_medium, risk_high

Example: risk_low
assessment_commentstringOptional

string

Example: Lorem ipsum dolor sit amet
Responses
200
OK
application/json
post
POST /api/v1/verifications/{verification_id}/state/qa HTTP/1.1
Host: api.app.gatenox.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 75

{
  "assessment": "risk_low",
  "assessment_comment": "Lorem ipsum dolor sit amet"
}
{
  "verification": {
    "id": "2d926af7-2397-4296-865a-4e7cd93017c0",
    "company_name": "GATENOX LIMITED",
    "company_number": "13714107",
    "status": "qa",
    "assessment": "risk_low",
    "revision_timestamps": [
      1676050354,
      1676555644
    ],
    "created_at": "2023-02-10T17:32:34.337Z",
    "updated_at": "2023-03-15T11:55:42.712Z",
    "qa_comment": null,
    "assessment_comment": "Lorem ipsum dolor sit amet",
    "company_jurisdiction": {
      "id": "53a304ad-6f2b-45a8-a37a-f0de379a0155",
      "code": "gb",
      "name": "United Kingdom",
      "country": "United Kingdom",
      "full_name": "United Kingdom"
    },
    "assigned_to": null
  }
}

Back to Compliance

post
Authorizations
Path parameters
verification_idstringRequiredExample: 2d926af7-2397-4296-865a-4e7cd93017c0
Body
qa_commentstringOptional

string

Example: Lorem ipsum dolor sit amet
Responses
200
OK
application/json
post
POST /api/v1/verifications/{verification_id}/state/back_to_compliance HTTP/1.1
Host: api.app.gatenox.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 43

{
  "qa_comment": "Lorem ipsum dolor sit amet"
}
{
  "verification": {
    "id": "2d926af7-2397-4296-865a-4e7cd93017c0",
    "company_name": "GATENOX LIMITED",
    "company_number": "13714107",
    "status": "in_progress",
    "assessment": "risk_low",
    "revision_timestamps": [
      1676050354,
      1676555644
    ],
    "created_at": "2023-02-10T17:32:34.337Z",
    "updated_at": "2023-03-15T11:57:49.693Z",
    "qa_comment": "Lorem ipsum dolor sit amet",
    "assessment_comment": "Lorem ipsum dolor sit amet",
    "company_jurisdiction": {
      "id": "53a304ad-6f2b-45a8-a37a-f0de379a0155",
      "code": "gb",
      "name": "United Kingdom",
      "country": "United Kingdom",
      "full_name": "United Kingdom"
    },
    "assigned_to": null
  }
}

Complete

post
Authorizations
Path parameters
verification_idstringRequiredExample: 2d926af7-2397-4296-865a-4e7cd93017c0
Body
assessmentstringOptional

enum: risk_low, risk_medium, risk_high

Example: risk_medium
assessment_commentstringOptional

string

Example: Lorem ipsum dolor sit amet
qa_commentstringOptional

string

Example: Lorem ipsum dolor sit amet
Responses
200
OK
application/json
post
POST /api/v1/verifications/{verification_id}/state/complete HTTP/1.1
Host: api.app.gatenox.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 120

{
  "assessment": "risk_medium",
  "assessment_comment": "Lorem ipsum dolor sit amet",
  "qa_comment": "Lorem ipsum dolor sit amet"
}
200

OK

{
  "verification": {
    "id": "2d926af7-2397-4296-865a-4e7cd93017c0",
    "company_name": "GATENOX LIMITED",
    "company_number": "13714107",
    "status": "completed",
    "assessment": "risk_medium",
    "revision_timestamps": [
      1676050354,
      1676555644
    ],
    "created_at": "2023-02-10T17:32:34.337Z",
    "updated_at": "2023-03-15T12:03:51.955Z",
    "qa_comment": "Lorem ipsum dolor sit amet",
    "assessment_comment": "Lorem ipsum dolor sit amet",
    "company_jurisdiction": {
      "id": "53a304ad-6f2b-45a8-a37a-f0de379a0155",
      "code": "gb",
      "name": "United Kingdom",
      "country": "United Kingdom",
      "full_name": "United Kingdom"
    },
    "assigned_to": null
  }
}

Rejected

post
Authorizations
Path parameters
verification_idstringRequiredExample: 2d92fc77-c14c-4c6b-bed9-acfe015696ca
Body
rejection_commentstringOptionalExample: Lorem ipsum dolor sit amet
Responses
200
OK
application/json
post
POST /api/v1/verifications/{verification_id}/state/rejected HTTP/1.1
Host: api.app.gatenox.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 50

{
  "rejection_comment": "Lorem ipsum dolor sit amet"
}
200

OK

{
  "verification": {
    "id": "2d92fc77-c14c-4c6b-bed9-acfe015696ca",
    "customer_id": "",
    "status": "rejected",
    "entity_name": "Company Labs",
    "entity_identifier": "5342482393",
    "entity_contact_email": "[email protected]",
    "revision_timestamps": [
      1718378060,
      1718628803,
      1718789789
    ],
    "created_at": "2024-06-14T15:14:20.248Z",
    "updated_at": "2024-06-19T09:38:52.398Z",
    "company_name": "Company Labs",
    "company_number": "5342482393",
    "access_type": "verifier_compliance_officer",
    "last_data_update": "2024-06-19T09:36:29.000Z",
    "verification_type": "primary",
    "rejection_comment": "Lorem ipsum dolor sit amet",
    "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": "bab81ba5-3bee-46b2-8fc6-629730445cad",
      "created_at": "2024-06-19T09:36:30.106Z",
      "updated_at": "2024-06-19T09:36:30.106Z",
      "verification_id": "2d92fc77-c14c-4c6b-bed9-acfe015696ca"
    }
  }
}

Reopen

post
Authorizations
Path parameters
verification_idstringRequiredExample: 2d926af7-2397-4296-865a-4e7cd93017c0
Body
Responses
200
OK
application/json
post
POST /api/v1/verifications/{verification_id}/state/reopen HTTP/1.1
Host: api.app.gatenox.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "verification": {
    "id": "2d926af7-2397-4296-865a-4e7cd93017c0",
    "company_name": "GATENOX LIMITED",
    "company_number": "13714107",
    "status": "in_progress",
    "assessment": "risk_medium",
    "revision_timestamps": [
      1676050354,
      1676555644
    ],
    "created_at": "2023-02-10T17:32:34.337Z",
    "updated_at": "2023-03-15T12:03:51.955Z",
    "qa_comment": "Lorem ipsum dolor sit amet",
    "assessment_comment": "Lorem ipsum dolor sit amet",
    "company_jurisdiction": {
      "id": "53a304ad-6f2b-45a8-a37a-f0de379a0155",
      "code": "gb",
      "name": "United Kingdom",
      "country": "United Kingdom",
      "full_name": "United Kingdom"
    },
    "assigned_to": null
  }
}

Last updated

Was this helpful?