Corporate verifications

Get the link for your client to start the corporate verification process (KYB)

Create Invite

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

Body

application/json

recipientsarray of POST_apiv1invitescorporates_recipients (object)

Response

201

Created

Body

application/json

invitesarray of POST_apiv1invitescorporates_response_201_invites (object)

Request

JavaScriptCurl

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

Response

{
  "invites": [
    {
      "id": "text",
      "email": "text",
      "type": "text",
      "redirect_url_success": "text",
      "redirect_url_failure": "text",
      "updated_at": "text",
      "created_at": "text",
      "state": "text"
    }
  ]
}

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

Parameter	Values	Info	Required?
email			Yes
redirect_url_success			No
redirect_url_failure			No
customer_id		external id to be used to match invitation with verification	No

Get the list of all your company verifications and their details

List

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

Query parameters

Response

200

OK

Body

application/json

verificationsarray of GET_apiv1verifications_response_200_verifications (object)

Request

JavaScriptCurl

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

Response

{
  "verifications": [
    {
      "id": "text",
      "customer_id": "text",
      "status": "text",
      "entity_name": "text",
      "entity_identifier": "text",
      "revision_timestamps": [
        0
      ],
      "created_at": "text",
      "updated_at": "text",
      "access_type": "text",
      "last_data_update": "text",
      "verification_type": "text",
      "company_jurisdiction": {
        "id": "text",
        "code": "text",
        "name": "text",
        "country": "text",
        "full_name": "text"
      }
    }
  ]
}

Details

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

Authorization

bearerAuth

Path parameters

id*string

Query parameters

Response

200

OK

Body

application/json

verificationGET_apiv1verificationsid_response_200_verification (object)

Request

JavaScriptCurl

const response = await fetch('https://api.app.gatenox.com/api/v1/verifications/{id}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "verification": {
    "id": "text",
    "customer_id": "text",
    "status": "text",
    "entity_name": "text",
    "entity_identifier": "text",
    "revision_timestamps": [
      0
    ],
    "created_at": "text",
    "updated_at": "text",
    "access_type": "text",
    "last_data_update": "text",
    "verification_type": "text",
    "company_jurisdiction": {
      "id": "text",
      "code": "text",
      "name": "text",
      "country": "text",
      "full_name": "text"
    }
  }
}

Get details about the company, which sent the application

Company Details

GEThttps://api.app.gatenox.com/api/v1/verifications/{verification_id}/company_details

Path parameters

verification_id*string

Query parameters

Response

200400

OK

Body

application/json

companyGET_apiv1verificationsverification_idcompany_details_response_200_company (object)

registered_addressGET_apiv1verificationsverification_idcompany_details_response_200_registered_address (object)

office_addressGET_apiv1verificationsverification_idcompany_details_response_200_office_address (object)

proof_of_incorporation_detailsarray of GET_apiv1verificationsverification_idcompany_details_response_200_proof_of_incorporation_details (object)

proof_of_office_addressarray of GET_apiv1verificationsverification_idcompany_details_response_200_proof_of_office_address (object)

Request

JavaScriptCurl

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

Response

{
  "company": {
    "id": "text",
    "formal_name": "text",
    "brand_name": "text",
    "company_number": "text",
    "inactive": false,
    "public_stock_exchange": false,
    "date_of_incorporation": "text",
    "jurisdiction": {
      "id": "text",
      "code": "text",
      "name": "text",
      "country": "text",
      "full_name": "text"
    },
    "company_type": {
      "id": "text",
      "short_name": "text",
      "full_name": "text",
      "description": "text",
      "jurisdiction_code": "text"
    },
    "industry": {
      "main": {
        "key": 0,
        "value": "text",
        "industry": "text",
        "keywords": [
          "text"
        ]
      },
      "description": "text",
      "additional_keys": []
    },
    "business_description": "text",
    "products_description": "text",
    "business_activity_countries": [
      "text"
    ],
    "tax_number": "text",
    "funds_sources": "text",
    "bank_accounts": [
      {
        "id": "text",
        "account_holder": "text",
        "address": "text",
        "iban": false,
        "name": "text",
        "number": "text",
        "created_at": "text",
        "updated_at": "text"
      }
    ],
    "crypto_addresses": [
      {
        "id": "text",
        "address": "text",
        "address_type": "text",
        "signature_message": "text",
        "signature_verification": "text",
        "created_at": "text",
        "updated_at": "text"
      }
    ],
    "website": "text",
    "phone_number": "text",
    "email": "text",
    "employees_count": "text",
    "aml_contact_person": "text",
    "aml_contact_email": "text",
    "aml_contact_phone_number": "text",
    "investigations": false,
    "prosecutions": false,
    "ubo_criminal_records": false,
    "registration_authority": "text",
    "license_date_of_expiry": "text",
    "license_date_of_issue": "text",
    "license_issuing_authority": "text",
    "license_number": "text",
    "license_required": false
  },
  "registered_address": {
    "id": "text",
    "name": "text",
    "line_1": "text",
    "line_2": "text",
    "postcode": "text",
    "city": "text",
    "country": "text",
    "created_at": "text",
    "updated_at": "text"
  },
  "office_address": {
    "id": "text",
    "name": "text",
    "line_1": "text",
    "line_2": "text",
    "postcode": "text",
    "city": "text",
    "country": "text",
    "created_at": "text",
    "updated_at": "text"
  },
  "proof_of_incorporation_details": [
    {
      "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"
            }
          }
        ]
      }
    }
  ],
  "proof_of_office_address": [
    {
      "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"
            }
          }
        ]
      }
    }
  ]
}

Graph

GEThttps://api.app.gatenox.com/api/v1/verifications/{verification_id}/graph

Path parameters

verification_id*string

Query parameters

Response

200

OK

Body

application/json

graphGET_apiv1verificationsverification_idgraph_response_200_graph (object)

Request

JavaScriptCurl

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

Response

{
  "graph": {
    "acyclic": false,
    "vertices": [
      {
        "id": "text",
        "type": "text",
        "labels": {
          "name": "text",
          "root": false,
          "shareholder": [
            {
              "company_id": "text",
              "shares": 0
            }
          ],
          "calculated_shares": 0,
          "given_names": "text",
          "surname": "text",
          "ubo": [
            {
              "company_id": "text",
              "shares": 0
            }
          ],
          "director": [
            {
              "company_id": "text",
              "position": "text"
            }
          ]
        }
      }
    ],
    "edges": [
      {
        "source": "text",
        "target": "text",
        "labels": {
          "types": [
            "text"
          ],
          "shares": 0
        }
      }
    ]
  }
}

The list of all people (directors, UBOs, individual shareholders, company representatives, others)

List

GEThttps://api.app.gatenox.com/api/v1/verifications/{verification_id}/people

Path parameters

verification_id*string

Query parameters

Response

200

OK

Body

application/json

peoplearray of GET_apiv1verificationsverification_idpeople_response_200_people (object)

Request

JavaScriptCurl

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

Response

{
  "people": [
    {
      "id": "text",
      "surname": "text",
      "given_names": "text",
      "date_of_birth": "text",
      "sex": "text",
      "nationality": "text",
      "pep": false,
      "place_of_birth": "text",
      "funds_sources": "text",
      "created_at": "text",
      "updated_at": "text"
    }
  ]
}

List

GEThttps://api.app.gatenox.com/api/v1/verifications/{verification_id}/companies

Path parameters

verification_id*string

Query parameters

Response

200

OK

Body

application/json

companiesarray of GET_apiv1verificationsverification_idcompanies_response_200_companies (object)

Request

JavaScriptCurl

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

Response

{
  "companies": [
    {
      "id": "text",
      "formal_name": "text",
      "company_number": "text",
      "jurisdiction": {
        "id": "text",
        "code": "text",
        "name": "text",
        "country": "text",
        "full_name": "text"
      },
      "company_type": {
        "id": "text",
        "short_name": "text",
        "full_name": "text",
        "description": "text",
        "jurisdiction_code": "text"
      },
      "industry": {
        "main": {
          "key": 0,
          "value": "text",
          "industry": "text",
          "keywords": [
            "text"
          ]
        }
      }
    }
  ]
}

Details

GEThttps://api.app.gatenox.com/api/v1/verifications/{verification_id}/companies/{id}

Path parameters

verification_id*string

id*string

Query parameters

Response

200

OK

Body

application/json

companyGET_apiv1verificationsverification_idcompaniesid_response_200_company (object)

Request

JavaScriptCurl

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

Response

{
  "company": {
    "id": "text",
    "formal_name": "text",
    "brand_name": "text",
    "company_number": "text",
    "inactive": false,
    "public_stock_exchange": false,
    "date_of_incorporation": "text",
    "jurisdiction": {
      "id": "text",
      "code": "text",
      "name": "text",
      "country": "text",
      "full_name": "text"
    },
    "company_type": {
      "id": "text",
      "short_name": "text",
      "full_name": "text",
      "description": "text",
      "jurisdiction_code": "text"
    },
    "industry": {
      "main": {
        "key": 0,
        "value": "text",
        "industry": "text",
        "keywords": [
          "text"
        ]
      },
      "description": "text",
      "additional_keys": []
    },
    "business_description": "text",
    "products_description": "text",
    "business_activity_countries": [
      "text"
    ],
    "tax_number": "text",
    "funds_sources": "text",
    "bank_accounts": [
      {
        "id": "text",
        "account_holder": "text",
        "address": "text",
        "iban": false,
        "name": "text",
        "number": "text",
        "created_at": "text",
        "updated_at": "text"
      }
    ],
    "crypto_addresses": [
      {
        "id": "text",
        "address": "text",
        "address_type": "text",
        "signature_message": "text",
        "signature_verification": "text",
        "created_at": "text",
        "updated_at": "text"
      }
    ],
    "website": "text",
    "phone_number": "text",
    "email": "text",
    "employees_count": "text",
    "aml_contact_person": "text",
    "aml_contact_email": "text",
    "aml_contact_phone_number": "text",
    "investigations": false,
    "prosecutions": false,
    "ubo_criminal_records": false,
    "registration_authority": "text",
    "license_date_of_expiry": "text",
    "license_date_of_issue": "text",
    "license_issuing_authority": "text",
    "license_number": "text",
    "license_required": false
  }
}

The list of company directors

List

GEThttps://api.app.gatenox.com/api/v1/verifications/{verification_id}/directors

Path parameters

verification_id*string

Query parameters

Response

200

OK

Body

application/json

directorsarray of GET_apiv1verificationsverification_iddirectors_response_200_directors (object)

Request

JavaScriptCurl

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

Response

{
  "directors": [
    {
      "id": "text",
      "position": "text",
      "created_at": "text",
      "updated_at": "text",
      "person": {
        "id": "text",
        "surname": "text",
        "given_names": "text",
        "date_of_birth": "text",
        "sex": "text",
        "nationality": "text",
        "pep": false,
        "place_of_birth": "text",
        "funds_sources": "text",
        "created_at": "text",
        "updated_at": "text"
      }
    }
  ]
}

Details

GEThttps://api.app.gatenox.com/api/v1/verifications/{verification_id}/directors/{id}

Path parameters

verification_id*string

id*string

Query parameters

Response

200

OK

Body

application/json

directorGET_apiv1verificationsverification_iddirectorsid_response_200_director (object)

Request

JavaScriptCurl

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

Response

{
  "director": {
    "id": "text",
    "position": "text",
    "created_at": "text",
    "updated_at": "text",
    "person": {
      "id": "text",
      "surname": "text",
      "given_names": "text",
      "date_of_birth": "text",
      "sex": "text",
      "nationality": "text",
      "pep": false,
      "place_of_birth": "text",
      "funds_sources": "text",
      "created_at": "text",
      "updated_at": "text",
      "address_of_residence": {
        "id": "text",
        "name": "text",
        "line_1": "text",
        "line_2": "text",
        "postcode": "text",
        "city": "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"
                }
              }
            ]
          }
        }
      ]
    }
  }
}

The list of UBOs

List

GEThttps://api.app.gatenox.com/api/v1/verifications/{verification_id}/ubos

Path parameters

verification_id*string

Query parameters

Response

200

OK

Body

application/json

ubosarray of GET_apiv1verificationsverification_idubos_response_200_ubos (object)

Request

JavaScriptCurl

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

Response

{
  "ubos": [
    {
      "id": "text",
      "approximate_percentage_of_shares": 0,
      "description": "text",
      "natures_of_control": [],
      "created_at": "text",
      "updated_at": "text",
      "person": {
        "id": "text",
        "surname": "text",
        "given_names": "text",
        "date_of_birth": "text",
        "sex": "text",
        "nationality": "text",
        "pep": false,
        "place_of_birth": "text",
        "funds_sources": "text",
        "created_at": "text",
        "updated_at": "text"
      }
    }
  ]
}

Details

GEThttps://api.app.gatenox.com/api/v1/verifications/{verification_id}/ubos/{id}

Path parameters

verification_id*string

id*string

Query parameters

Response

200

OK

Body

application/json

uboGET_apiv1verificationsverification_idubosid_response_200_ubo (object)

Request

JavaScriptCurl

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

Response

{
  "ubo": {
    "id": "text",
    "approximate_percentage_of_shares": 0,
    "description": "text",
    "natures_of_control": [],
    "created_at": "text",
    "updated_at": "text",
    "person": {
      "id": "text",
      "surname": "text",
      "given_names": "text",
      "date_of_birth": "text",
      "sex": "text",
      "nationality": "text",
      "pep": false,
      "place_of_birth": "text",
      "funds_sources": "text",
      "created_at": "text",
      "updated_at": "text",
      "address_of_residence": {
        "id": "text",
        "name": "text",
        "line_1": "text",
        "line_2": "text",
        "postcode": "text",
        "city": "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"
                }
              }
            ]
          }
        }
      ]
    }
  }
}

Company documents

List

GEThttps://api.app.gatenox.com/api/v1/verifications/{verification_id}/company_documents

Path parameters

verification_id*string

Query parameters

Response

200

OK

Body

application/json

company_documentsarray of GET_apiv1verificationsverification_idcompany_documents_response_200_company_documents (object)

Request

JavaScriptCurl

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

Response

{
  "company_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"
            }
          }
        ]
      }
    }
  ]
}

Details

GEThttps://api.app.gatenox.com/api/v1/verifications/{verification_id}/company_documents/{id}

Path parameters

verification_id*string

id*string

Query parameters

Response

200

OK

Body

application/json

company_documentGET_apiv1verificationsverification_idcompany_documentsid_response_200_company_document (object)

Request

JavaScriptCurl

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

Response

{
  "company_document": {
    "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"
          }
        }
      ]
    }
  }
}