Individual verifications

Get the link for your client to start the individual verification process (KYC)

Individuals

POSThttps://api.app.gatenox.com/api/v1/invites/individuals

Body

application/json

recipientsarray of POST_apiv1invitesindividuals_recipients (object)

Response

200201422

OK

Body

application/json

personal_verificationsarray of POST_apiv1invitesindividuals_response_200_personal_verifications (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.app.gatenox.com/api/v1/invites/individuals', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200201422

{
  "personal_verifications": [
    {
      "id": "text",
      "email": "text",
      "invitation_type": "text",
      "redirect_url_success": "text",
      "redirect_url_failure": "text",
      "updated_at": "text",
      "created_at": "text",
      "state": "text",
      "invitation_url": "text"
    }
  ]
}

The endpoint's body requires the following values to be included in the request:

Parameter	Values	Info	Required?
email		The customer's email address, where the invitation will be sent. I will also be displayed on the "Individual verifications" tab on the lists.	Yes
redirect_url_success		The URL, where the customer will be redirected if the KYC process finishes successfully.	No
redirect_url_failure		The URL, where the customer will be redirected if the KYC process fails.	No
customer_id		external id to be used to match invitation with verification	No

Upload externally calculated risk score

Update External Risk Score

POSThttps://api.app.gatenox.com/api/v1/webhooks/external_risk_score

Body

multipart/form-data

idstring

uuid

Example: "c02d2b4c-e207-4335-a15a-ceb325f8444f"

risk_score[simple]string

(optional) low, medium, high

Example: "low"

risk_score[detailed][score]string

string

Example: "99%"

risk_score[detailed][reasons][]string

string

Example: "Lorem ipsum dolor sit amet 2"

Response

200400

OK

Headers

Body

application/json

external_risk_scorePOST_apiv1webhooksexternal_risk_score_response_200_external_risk_score (object)

Request

JavaScriptCurlPython

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

Response

200400

{
  "external_risk_score": {
    "id": "text",
    "risk_score_simple": "text",
    "risk_score_detailed": {
      "score": "text",
      "reasons": [
        "text"
      ]
    },
    "created_at": "text",
    "updated_at": "text",
    "verification_id": "text"
  }
}

Get the list of all your individual verifications and their details

List

GEThttps://api.app.gatenox.com/api/v1/verification_individuals

Query parameters

Response

200

OK

Body

application/json

verification_individualsarray of GET_apiv1verification_individuals_response_200_verification_individuals (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.app.gatenox.com/api/v1/verification_individuals', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "verification_individuals": [
    {
      "id": "text",
      "customer_id": "text",
      "status": "text",
      "entity_name": "text",
      "entity_identifier": "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",
      "personal_verification_id": "text"
    }
  ]
}

Details

GEThttps://api.app.gatenox.com/api/v1/verification_individuals/{id}

Path parameters

id*string

Example: "0b98b29c-713c-4fe0-a60b-70504563a22e"

Query parameters

Response

200

OK

Body

application/json

verification_individualGET_apiv1verification_individualsid_response_200_verification_individual (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.app.gatenox.com/api/v1/verification_individuals/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "verification_individual": {
    "id": "text",
    "customer_id": "text",
    "status": "text",
    "entity_name": "text",
    "entity_identifier": "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",
    "personal_verification_id": "text"
  }
}

Details

GEThttps://api.app.gatenox.com/api/v1/verification_individuals/{verification_individual_id}/people

Path parameters

verification_individual_id*string

Example: "0b98b29c-713c-4fe0-a60b-70504563a22e"

Query parameters

Response

200

OK

Body

application/json

personGET_apiv1verification_individualsverification_individual_idpeople_response_200_person (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.app.gatenox.com/api/v1/verification_individuals/{verification_individual_id}/people', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "person": {
    "id": "text",
    "surname": "text",
    "given_names": "text",
    "date_of_birth": "text",
    "sex": "text",
    "nationality": "text",
    "pep": false,
    "pep_description": "text",
    "place_of_birth": "text",
    "title_position": "text",
    "created_at": "text",
    "updated_at": "text",
    "address_of_residence": {
      "id": "text",
      "line_1": "text",
      "postcode": "text",
      "city": "text",
      "state": "text",
      "country": "text",
      "created_at": "text",
      "updated_at": "text"
    },
    "documents": [
      {
        "id": "text",
        "purposes": [
          "text"
        ],
        "created_at": "text",
        "updated_at": "text",
        "document": {
          "id": "text",
          "name": "text",
          "document_type": "text",
          "created_at": "text",
          "updated_at": "text",
          "attachments": [
            {
              "id": "text",
              "attachment_type": "text",
              "created_at": "text",
              "updated_at": "text",
              "filename": "text",
              "filesize": 0,
              "mime": "text",
              "urls": {
                "thumb": "text",
                "medium": "text",
                "original": "text"
              }
            }
          ]
        }
      }
    ],
    "personal_verification": {
      "email": "text",
      "completed_at": "text",
      "updated_at": "text",
      "state": "text"
    }
  }
}

List

GEThttps://api.app.gatenox.com/api/v1/verification_individuals/{verification_individual_id}/addresses

Path parameters

verification_individual_id*string

Example: "0b98b29c-713c-4fe0-a60b-70504563a22e"

Query parameters

Response

200

OK

Body

application/json

addressesarray of GET_apiv1verification_individualsverification_individual_idaddresses_response_200_addresses (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.app.gatenox.com/api/v1/verification_individuals/{verification_individual_id}/addresses', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "addresses": [
    {
      "id": "text",
      "line_1": "text",
      "postcode": "text",
      "city": "text",
      "state": "text",
      "country": "text",
      "created_at": "text",
      "updated_at": "text"
    }
  ]
}

Details

GEThttps://api.app.gatenox.com/api/v1/verification_individuals/{verification_individual_id}/addresses/{id}

Path parameters

verification_individual_id*string

Example: "0b98b29c-713c-4fe0-a60b-70504563a22e"

id*string

Example: "ed7d5634-d928-4ddf-941c-540fc2a7e56f"

Query parameters

Response

200

OK

Headers

Body

application/json

addressGET_apiv1verification_individualsverification_individual_idaddressesid_response_200_address (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.app.gatenox.com/api/v1/verification_individuals/{verification_individual_id}/addresses/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "address": {
    "id": "text",
    "line_1": "text",
    "postcode": "text",
    "city": "text",
    "state": "text",
    "country": "text",
    "created_at": "text",
    "updated_at": "text"
  }
}

Audit Log

GEThttps://api.app.gatenox.com/api/v1/verification_individuals/{id}/audit_log

Path parameters

id*string

Example: "bba9d483-98bd-487c-bb7c-a77ddb615ff3"

Response

200

OK

Body

application/json

audit_logGET_apiv1verification_individualsidaudit_log_response_200_audit_log (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.app.gatenox.com/api/v1/verification_individuals/{id}/audit_log', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "audit_log": {
    "audits": [
      {
        "id": 0,
        "auditable_id": "text",
        "auditable_type": "text",
        "action": "text",
        "audited_changes": {
          "mode": "text",
          "status": "text",
          "reopen_at": [],
          "assessment": [],
          "entity_name": "text",
          "reviewed_tlc_id": "text",
          "reviewing_tlc_id": "text",
          "entity_identifier": "text",
          "assessment_comment": [],
          "revision_timestamps": [
            []
          ],
          "completeness_profile_id": "text",
          "trust_verification_cart_id": "text"
        },
        "version": 0,
        "request_uuid": "text",
        "created_at": "text",
        "comment": {
          "sanctions_check": "text",
          "sources": [
            {
              "source": "text",
              "name": "text",
              "description": "text",
              "link": "text",
              "country_name": "text"
            }
          ]
        }
      }
    ],
    "associated_audits": [
      {
        "id": 0,
        "auditable_id": "text",
        "auditable_type": "text",
        "associated_id": "text",
        "associated_type": "text",
        "action": "text",
        "audited_changes": {
          "people": [
            []
          ],
          "companies": [],
          "crypto_addresses": [],
          "report": {
            "name": "text",
            "source": {
              "link": "text",
              "name": "text",
              "source": "text",
              "description": "text",
              "country_name": "text"
            },
            "address": [
              {
                "city": "text",
                "line1": "text",
                "line2": "text",
                "line3": "text",
                "state": "text",
                "postal": "text",
                "country": "text"
              }
            ],
            "unique_id": "text",
            "last_names": [
              "text"
            ],
            "alias_names": [
              "text"
            ],
            "citizenship": [
              "text"
            ],
            "given_names": [
              "text"
            ],
            "source_type": "text",
            "date_of_birth": [
              "text"
            ],
            "alias_given_names": [
              "text"
            ],
            "links": [
              "text"
            ],
            "gender": "text",
            "list_date": "text",
            "positions": [
              "text"
            ],
            "source_id": "text",
            "entity_type": "text",
            "place_of_birth": [
              "text"
            ],
            "sanction_details": [
              "text"
            ],
            "other_information": [
              "text"
            ],
            "citizenship_remarks": [
              "text"
            ],
            "spouse": [
              "text"
            ],
            "parents": [
              "text"
            ],
            "children": [
              "text"
            ],
            "pep_type": "text",
            "description": [
              "text"
            ],
            "occupations": [
              "text"
            ],
            "functions": [
              "text"
            ],
            "titles": [
              "text"
            ]
          },
          "source": "text",
          "category": "text",
          "entity_id": "text",
          "review_id": "text",
          "entity_type": "text",
          "source_list_name": "text",
          "source_unique_id": "text"
        },
        "version": 0,
        "request_uuid": "text",
        "created_at": "text"
      }
    ]
  }
}

Individual documents

Download Attachement

GEThttps://api.app.gatenox.com/api/v1/attachments/{rest}

Path parameters

rest*string

Example: "eyJpZCI6ImI4NmQyMTE4NmU2YmZiNmM5Mjg2ZWNiOTU0N2JhYzNlLnBkZiIsInN0b3JhZ2UiOiJzdG9yZSIsIm1ldGFkYXRhIjp7ImZpbGVuYW1lIjpudWxsLCJzaXplIjoxNzYzNTYsIm1pbWVfdHlwZSI6ImFwcGxpY2F0aW9uL3BkZiJ9fQ"

Response

200

Successful response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('https://api.app.gatenox.com/api/v1/attachments/{rest}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Upload externally calculated risk score

Update External Risk Score

POSThttps://api.app.gatenox.com/api/v1/webhooks/external_risk_score

Body

multipart/form-data

idstring

uuid

Example: "c02d2b4c-e207-4335-a15a-ceb325f8444f"

risk_score[simple]string

(optional) low, medium, high

Example: "low"

risk_score[detailed][score]string

string

Example: "99%"

risk_score[detailed][reasons][]string

string

Example: "Lorem ipsum dolor sit amet 2"

Response

200400

OK

Headers

Body

application/json

external_risk_scorePOST_apiv1webhooksexternal_risk_score_response_200_external_risk_score (object)

Request

JavaScriptCurlPython

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

Response

200400

{
  "external_risk_score": {
    "id": "text",
    "risk_score_simple": "text",
    "risk_score_detailed": {
      "score": "text",
      "reasons": [
        "text"
      ]
    },
    "created_at": "text",
    "updated_at": "text",
    "verification_id": "text"
  }
}