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)

send_notificationboolean

Response

201

Created

Body

application/json

invitesarray of POST_apiv1invitescorporates_response_201_invites (object)

Request

JavaScriptCurlPython

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

201

{
  "invites": [
    {
      "id": "text",
      "email": "text",
      "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 "Corporate 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
completeness_profile_id		The verification profile to be used to gather data during the onboarding process.	No
send_notification		This parameter indicates if Gatenox Hub should send the email to the customer. By default, it is set to false.	No

Get the list of all your verification profiles

Completeness Profiles List

GEThttps://api.app.gatenox.com/api/v1/contexts/{context_id}/completeness_profiles

Path parameters

context_id*string

Example: "92930d22-4b32-4844-97c3-3176da131cb3"

Query parameters

Response

200

OK

Body

application/json

object

Request

JavaScriptCurlPython

const response = await fetch('https://api.app.gatenox.com/api/v1/contexts/{context_id}/completeness_profiles', {
    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"
  }
}

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

JavaScriptCurlPython

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

Response

200

{
  "verifications": [
    {
      "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",
      "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

Example: "6d04ab71-12ac-4728-bc1c-ae68da6a3513"

Query parameters

Response

200

OK

Body

application/json

verificationGET_apiv1verificationsid_response_200_verification (object)

Request

JavaScriptCurlPython

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

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",
    "access_type": "text",
    "last_data_update": "text",
    "verification_type": "text",
    "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"
    },
    "company_jurisdiction": {
      "id": "text",
      "code": "text",
      "name": "text",
      "country": "text",
      "full_name": "text"
    }
  }
}

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"
  }
}

Change the profile of gathered data during the review process

It allows to change the scope of data requested from the corporate client and automatically sends the case to the customer changing the status to "Request for data update".

You can get the "completeness_profile_id" from the "Settings" menu. On the "Company Information" tab, in the "Onboarding profiles" section, select a profile name, and the "profile id" will be displayed.

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"
        }
      }
    }
  }
}

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

Example: "6d04ab71-12ac-4728-bc1c-ae68da6a3513"

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

JavaScriptCurlPython

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

200400

{
  "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

Example: "6d04ab71-12ac-4728-bc1c-ae68da6a3513"

Query parameters

Response

200

OK

Body

application/json

graphGET_apiv1verificationsverification_idgraph_response_200_graph (object)

Request

JavaScriptCurlPython

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

Response

200

{
  "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

Example: "6d04ab71-12ac-4728-bc1c-ae68da6a3513"

Query parameters

Response

200

OK

Body

application/json

peoplearray of GET_apiv1verificationsverification_idpeople_response_200_people (object)

Request

JavaScriptCurlPython

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

Response

200

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

Details

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

Path parameters

verification_id*string

Example: "6d04ab71-12ac-4728-bc1c-ae68da6a3513"

id*string

Example: "646b6c85-faa1-41cd-9341-54d341196051"

Query parameters

Response

200

OK

Body

application/json

personGET_apiv1verificationsverification_idpeopleid_response_200_person (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.app.gatenox.com/api/v1/verifications/{verification_id}/people/{id}', {
    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,
    "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"
              }
            }
          ]
        }
      }
    ]
  }
}

List

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

Path parameters

verification_id*string

Example: "6d04ab71-12ac-4728-bc1c-ae68da6a3513"

Query parameters

Response

200

OK

Body

application/json

companiesarray of GET_apiv1verificationsverification_idcompanies_response_200_companies (object)

Request

JavaScriptCurlPython

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

Response

200

{
  "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

Example: "6d04ab71-12ac-4728-bc1c-ae68da6a3513"

id*string

Example: "f8f658cb-bcca-4253-97cf-4d585c6f9ce8"

Query parameters

Response

200

OK

Body

application/json

companyGET_apiv1verificationsverification_idcompaniesid_response_200_company (object)

Request

JavaScriptCurlPython

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

200

{
  "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

Example: "6d04ab71-12ac-4728-bc1c-ae68da6a3513"

Query parameters

Response

200

OK

Body

application/json

directorsarray of GET_apiv1verificationsverification_iddirectors_response_200_directors (object)

Request

JavaScriptCurlPython

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

Response

200

{
  "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

Example: "6d04ab71-12ac-4728-bc1c-ae68da6a3513"

id*string

Example: "45f836d7-d374-49cf-aad0-64e45d07394c"

Query parameters

Response

200

OK

Body

application/json

directorGET_apiv1verificationsverification_iddirectorsid_response_200_director (object)

Request

JavaScriptCurlPython

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

200

{
  "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

Example: "6d04ab71-12ac-4728-bc1c-ae68da6a3513"

Query parameters

Response

200

OK

Body

application/json

ubosarray of GET_apiv1verificationsverification_idubos_response_200_ubos (object)

Request

JavaScriptCurlPython

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

Response

200

{
  "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

Example: "6d04ab71-12ac-4728-bc1c-ae68da6a3513"

id*string

Example: "6d61b492-e05a-4acc-a7bf-0e774793bfa1"

Query parameters

Response

200

OK

Body

application/json

uboGET_apiv1verificationsverification_idubosid_response_200_ubo (object)

Request

JavaScriptCurlPython

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

200

{
  "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

Example: "6d04ab71-12ac-4728-bc1c-ae68da6a3513"

Query parameters

Response

200

OK

Body

application/json

company_documentsarray of GET_apiv1verificationsverification_idcompany_documents_response_200_company_documents (object)

Request

JavaScriptCurlPython

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

200

{
  "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

Example: "6d04ab71-12ac-4728-bc1c-ae68da6a3513"

id*string

Example: "c6365534-60b4-4f11-81c9-0c32e25b28f4"

Query parameters

Response

200

OK

Body

application/json

company_documentGET_apiv1verificationsverification_idcompany_documentsid_response_200_company_document (object)

Request

JavaScriptCurlPython

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

200

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

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();