Corporate verifications

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

Create Invite

post

https://api.app.gatenox.comhttps://api.sandbox.gatenox.com

/api/v1/invites/corporates

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

send_notificationbooleanOptional

Responses

201

Created

application/json

post

/api/v1/invites/corporates

HTTPcURLJavaScriptPython

POST /api/v1/invites/corporates HTTP/1.1
Host: api.app.gatenox.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 3473

{
  "recipients": [
    {
      "email": "[email protected]",
      "redirect_url_success": "https://example.com/success",
      "redirect_url_failure": "https://example.com/failure",
      "customer_id": "TEST_MARIUSZ_26",
      "company_data": {
        "company_details": {
          "company": {
            "formal_name": "[MARIUSZ026] Tech Solutions Ltd.",
            "brand_name": "[MARIUSZ026] Tech Solutions",
            "company_number": "123456",
            "date_of_incorporation": "2023-05-15",
            "jurisdiction": {
              "country": "Poland"
            },
            "company_type": {
              "short_name": "SA",
              "full_name": "Spółka akcyjna"
            },
            "industry": {
              "main": {
                "key": 154
              },
              "description": "Information Technology Services"
            },
            "business_description": "Providing innovative IT solutions to global clients.",
            "business_activity_countries": [
              "poland",
              "germany",
              "gb"
            ],
            "tax_number": "GB123456789",
            "public_stock_exchange": false,
            "funds_sources": "Investments and client contracts",
            "crypto_addresses": [
              {
                "address": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
                "address_type": "BTC"
              }
            ]
          },
          "registered_address": {
            "line_1": "24 High Street",
            "line_2": "Suite 301",
            "postcode": "AB12 3CD",
            "city": "London",
            "country": "GB"
          },
          "office_address": {
            "line_1": "24 High Street",
            "line_2": "Suite 301",
            "postcode": "AB12 3CD",
            "city": "London",
            "country": "GB"
          },
          "proof_of_incorporation_details": [
            {
              "document": {
                "name": "Certificate of Incorporation",
                "document_type": "other",
                "attachments": [
                  {
                    "attachment_type": "main",
                    "filename": "certificate.pdf",
                    "url": "https://pdfobject.com/pdf/sample.pdf"
                  }
                ]
              }
            }
          ],
          "proof_of_office_address": []
        },
        "directors": [
          {
            "position": "CEO",
            "person": {
              "surname": "Smith",
              "given_names": "John",
              "date_of_birth": "1980-12-15",
              "nationality": "United Kingdom",
              "place_of_birth": "UK",
              "personal_number": "1234567890",
              "documents": [
                {
                  "purposes": [
                    "residence_address_confirmation"
                  ],
                  "document": {
                    "name": "Utility Bill",
                    "document_type": "recent_utility_bill",
                    "attachments": [
                      {
                        "attachment_type": "main",
                        "filename": "utility_bill.pdf",
                        "url": "https://pdfobject.com/pdf/sample.pdf"
                      }
                    ]
                  }
                },
                {
                  "purposes": [
                    "personal_document"
                  ],
                  "document": {
                    "name": "Passport",
                    "document_type": "identity_card",
                    "attachments": [
                      {
                        "attachment_type": "front",
                        "filename": "passport.pdf",
                        "url": "https://pdfobject.com/pdf/sample.pdf"
                      }
                    ]
                  }
                }
              ]
            }
          }
        ],
        "corporate_shareholders": [
          {
            "approximate_percentage_of_shares": 50,
            "company": {
              "formal_name": "Tech Investments Inc.",
              "brand_name": "Tech Investments",
              "company_number": "987654321",
              "date_of_incorporation": "2000-01-01",
              "jurisdiction": {
                "country": "Germany"
              },
              "company_type": {
                "short_name": "Inc.",
                "full_name": "Corporation"
              }
            },
            "registered_address": {
              "line_1": "123 Market Street",
              "line_2": "Suite 501",
              "postcode": "XYZ123",
              "city": "New York",
              "country": "US"
            },
            "office_address": {
              "line_1": "123 Market Street",
              "line_2": "Suite 501",
              "postcode": "XYZ123",
              "city": "New York",
              "country": "US"
            }
          }
        ],
        "ubos": [
          {
            "approximate_percentage_of_shares": 50,
            "person": {
              "surname": "Johnson",
              "given_names": "Emily",
              "date_of_birth": "1975-08-20",
              "nationality": "USA",
              "place_of_birth": "USA",
              "personal_number": "9876543210",
              "address_of_residence": {
                "line_1": "456 Maple Avenue",
                "line_2": "Apt 201",
                "postcode": "AB34 5DE",
                "city": "San Francisco",
                "state": "California",
                "country": "US"
              },
              "documents": [
                {
                  "purposes": [
                    "residence_address_confirmation"
                  ],
                  "document": {
                    "name": "CV",
                    "document_type": "recent_utility_bill",
                    "attachments": [
                      {
                        "attachment_type": "main",
                        "filename": "cv.pdf",
                        "url": "https://pdfobject.com/pdf/sample.pdf"
                      }
                    ]
                  }
                },
                {
                  "purposes": [
                    "personal_document"
                  ],
                  "document": {
                    "name": "ID Card",
                    "document_type": "identity_card",
                    "attachments": [
                      {
                        "attachment_type": "back",
                        "filename": "id_card.pdf",
                        "url": "https://pdfobject.com/pdf/sample.pdf"
                      }
                    ]
                  }
                }
              ]
            }
          }
        ]
      }
    }
  ],
  "send_notification": true
}

201

Created

{
  "invites": [
    {
      "id": "bed7ef7f-fc5e-4fa6-aeb1-aa986e3f6975",
      "email": "[email protected]",
      "type": "Invite::CorporateKYC",
      "redirect_url_success": "https://example.com/success",
      "redirect_url_failure": "https://example.com/failure",
      "updated_at": "2024-04-17T14:42:52.424Z",
      "created_at": "2024-04-17T14:42:52.424Z",
      "state": "invited",
      "invitation_url": "https://localhost:3333/referrals/join/gatenox/fca539cf-1a5e-4993-9169-08f51428350a"
    }
  ]
}

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

get

https://api.app.gatenox.comhttps://api.sandbox.gatenox.com

/api/v1/contexts/{context_id}/completeness_profiles

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

context_idstringRequiredExample: 92930d22-4b32-4844-97c3-3176da131cb3

Query parameters

typestringOptionalExample: main

Responses

200

OK

application/json

Responseobject

get

/api/v1/contexts/{context_id}/completeness_profiles

HTTPcURLJavaScriptPython

GET /api/v1/contexts/{context_id}/completeness_profiles HTTP/1.1
Host: api.app.gatenox.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "completeness_profile": {
    "id": "f3d0329b-6a48-435d-8823-904cd2a25d6b",
    "name": "DEFAULT MINIMUM",
    "profile_type": "main",
    "requirements_description": [
      "Company Detials: jurisdiction, company number, company formal name",
      "Directors: at least one director, Surname, given names",
      "Shareholders: at least one shareholder (individual or corporate)",
      "Individual shareholders: surname, given names",
      "Corporate shareholders: jurisdiction, company number, company formal name",
      "UBO: surname, given names",
      "",
      "To add more required data contact our sales at [email protected]."
    ],
    "created_at": "2022-11-14T10:49:08.958Z",
    "updated_at": "2022-11-14T13:41:04.752Z",
    "additional_fields": [
      {
        "id": "6f398892-45f5-4a30-ae9a-351b145f4c44",
        "name": "name_1",
        "label": "Lorem ipsum dolor sit amet",
        "entity_type": "Company",
        "field_type": "select",
        "options": [
          {
            "label": "Lorem Ipsum",
            "value": "lorem_ipsum"
          }
        ],
        "created_at": "2024-06-04T14:14:27.421Z"
      }
    ],
    "completeness_rules": [
      {
        "entity": "company",
        "label": "Lorem ipsum name",
        "kind": "required",
        "section": "business_detail",
        "additional_field": {
          "id": "6f398892-45f5-4a30-ae9a-351b145f4c44",
          "name": "name_1",
          "label": "Lorem ipsum dolor sit amet",
          "entity_type": "Company",
          "field_type": "select",
          "options": [
            {
              "label": "Lorem Ipsum",
              "value": "lorem_ipsum"
            }
          ],
          "created_at": "2024-06-04T14:14:27.421Z"
        }
      },
      {
        "entity": "person",
        "fields": "surname",
        "label": "Please, provide person's surname",
        "kind": "required",
        "extra": null,
        "section": ""
      },
      {
        "entity": "person",
        "fields": "given_names",
        "label": "Please, provide person's given_names",
        "kind": "required",
        "extra": null,
        "section": ""
      },
      {
        "entity": "company",
        "fields": "company_number",
        "label": "Please provide your company number.",
        "kind": "required",
        "extra": null,
        "section": "business_identity"
      },
      {
        "entity": "company",
        "fields": "jurisdiction",
        "label": "Please provide jurisdiction, where your company is registered.",
        "kind": "required",
        "extra": null,
        "section": "business_identity"
      },
      {
        "entity": "company",
        "fields": "formal_name",
        "label": "Please provide your company formal name.",
        "kind": "required",
        "extra": null,
        "section": "business_identity"
      },
      {
        "entity": "corporate_shareholder",
        "fields": "company.individual_shareholders",
        "label": "Give access to individual shareholders",
        "kind": "show_field",
        "extra": {
          "level": []
        },
        "section": null
      },
      {
        "entity": "corporate_shareholder",
        "fields": "company.corporate_shareholders",
        "label": "Give access to corporate shareholders",
        "kind": "show_field",
        "extra": {
          "level": []
        },
        "section": null
      },
      {
        "entity": "corporate_shareholder",
        "fields": "company.jurisdiction",
        "label": "Please provide corporate shareholder's jurisdiction.",
        "kind": "required",
        "extra": {
          "level": []
        },
        "section": null
      },
      {
        "entity": "corporate_shareholder",
        "fields": "company.formal_name",
        "label": "Please provide corporate shareholder's formal name.",
        "kind": "required",
        "extra": {
          "level": []
        },
        "section": null
      },
      {
        "entity": "corporate_shareholder",
        "fields": "company.company_number",
        "label": "Please provide corporate shareholder's company number.",
        "kind": "required",
        "extra": {
          "level": []
        },
        "section": null
      },
      {
        "entity": "corporate_shareholder",
        "fields": "approximate_percentage_of_shares",
        "label": "Please provide corporate shareholder approximate percentage of shares.",
        "kind": "required",
        "extra": null,
        "section": "shareholder"
      },
      {
        "entity": "individual_shareholder",
        "fields": "approximate_percentage_of_shares",
        "label": "Please provide individual shareholder approximate percentage of shares.",
        "kind": "required",
        "extra": null,
        "section": "shareholder"
      },
      {
        "entity": "ubo",
        "fields": "approximate_percentage_of_shares",
        "label": "Please provide UBOs percentage of shares.",
        "kind": "required",
        "extra": null,
        "section": "ubo"
      },
      {
        "entity": "company",
        "fields": "date_of_incorporation",
        "label": "Please provide your company date of incorporation.",
        "kind": "required",
        "extra": null,
        "section": "business_detail"
      },
      {
        "entity": "company",
        "fields": "company_type",
        "label": "Please provide your company legal form.",
        "kind": "required",
        "extra": null,
        "section": "business_detail"
      },
      {
        "entity": "director",
        "fields": "position",
        "label": "Please provide director's position in company organization structure.",
        "kind": "required",
        "extra": null,
        "section": "business_representative"
      },
      {
        "entity": "director",
        "fields": "person.surname",
        "label": "Please, provide person's surname",
        "kind": "required",
        "extra": null,
        "section": "director"
      },
      {
        "entity": "director",
        "fields": "person.given_names",
        "label": "Please, provide person's given_names",
        "kind": "required",
        "extra": null,
        "section": "director"
      },
      {
        "entity": "individual_shareholder",
        "fields": "person.surname",
        "label": "Please, provide person's surname",
        "kind": "required",
        "extra": null,
        "section": "individual_shareholder"
      },
      {
        "entity": "individual_shareholder",
        "fields": "person.given_names",
        "label": "Please, provide person's given_names",
        "kind": "required",
        "extra": null,
        "section": "individual_shareholder"
      },
      {
        "entity": "ubo",
        "fields": "person.surname",
        "label": "Please, provide person's surname",
        "kind": "required",
        "extra": null,
        "section": "ubo"
      },
      {
        "entity": "ubo",
        "fields": "person.given_names",
        "label": "Please, provide person's given_names",
        "kind": "required",
        "extra": null,
        "section": "ubo"
      },
      {
        "entity": "ubo",
        "fields": "person.given_names",
        "label": "Please, provide person's given_names",
        "kind": "required",
        "extra": null,
        "section": "ubo"
      },
      {
        "entity": "ubo",
        "fields": "person.surname",
        "label": "Please, provide person's surname",
        "kind": "required",
        "extra": null,
        "section": "ubo"
      },
      {
        "entity": "ubo",
        "fields": "person.funds_sources",
        "label": "Please, provide person's funds_sources",
        "kind": "required",
        "extra": {},
        "section": "ubo"
      },
      {
        "entity": "ubo",
        "fields": "person.nationality",
        "label": "Please, provide person's nationality",
        "kind": "required",
        "extra": {},
        "section": "ubo"
      },
      {
        "entity": "ubo",
        "fields": "person.date_of_birth",
        "label": "Please, provide person's date_of_birth",
        "kind": "required",
        "extra": {},
        "section": "ubo"
      },
      {
        "entity": "ubo",
        "fields": "person.address_of_residence.line_1",
        "label": "Please, fulfill address detail: address_of_residence.line_1",
        "kind": "required",
        "extra": {
          "purpose": "residence_address_confirmation"
        },
        "section": "ubo"
      },
      {
        "entity": "ubo",
        "fields": "person.address_of_residence.city",
        "label": "Please, fulfill address detail: address_of_residence.city",
        "kind": "required",
        "extra": {
          "purpose": "residence_address_confirmation"
        },
        "section": "ubo"
      },
      {
        "entity": "ubo",
        "fields": "person.address_of_residence.country",
        "label": "Please, fulfill address detail: address_of_residence.country",
        "kind": "required",
        "extra": {
          "purpose": "residence_address_confirmation"
        },
        "section": "ubo"
      },
      {
        "entity": "ubo",
        "fields": "person.address_of_residence.postcode",
        "label": "Please, fulfill address detail: address_of_residence.postcode",
        "kind": "required",
        "extra": {
          "purpose": "residence_address_confirmation"
        },
        "section": "ubo"
      },
      {
        "entity": "ubo",
        "fields": "person.address_of_residence",
        "label": "Please, fulfill address detail: address_of_residence",
        "kind": "required",
        "extra": {},
        "section": "ubo"
      }
    ]
  }
}

Upload externally calculated risk score

Update External Risk Score

post

https://api.app.gatenox.comhttps://api.sandbox.gatenox.com

/api/v1/webhooks/external_risk_score

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

multipart/form-data

idstringOptional

uuid

Example: c02d2b4c-e207-4335-a15a-ceb325f8444f

risk_score[simple]stringOptional

(optional) low, medium, high

Example: low

risk_score[detailed][score]stringOptional

string

Example: 99%

risk_score[detailed][reasons][]stringOptional

string

Example: Lorem ipsum dolor sit amet 2

Responses

200

OK

application/json

400

Bad Request

application/json

post

/api/v1/webhooks/external_risk_score

HTTPcURLJavaScriptPython

POST /api/v1/webhooks/external_risk_score HTTP/1.1
Host: api.app.gatenox.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 173

{
  "id": "c02d2b4c-e207-4335-a15a-ceb325f8444f",
  "risk_score[simple]": "low",
  "risk_score[detailed][score]": "99%",
  "risk_score[detailed][reasons][]": "Lorem ipsum dolor sit amet 2"
}

{
  "external_risk_score": {
    "id": "c02d2b4c-e207-4335-a15a-ceb325f8444f",
    "risk_score_simple": "low",
    "risk_score_detailed": {
      "score": "99%",
      "reasons": [
        "Lorem ipsum dolor sit amet 1",
        "Lorem ipsum dolor sit amet 2"
      ]
    },
    "created_at": "2024-06-14T09:26:46.225Z",
    "updated_at": "2024-06-14T09:34:54.128Z",
    "verification_id": "ac6aaa98-d4b4-442f-a465-356b192ec5ac"
  }
}

Get the list of all your company verifications and their details

List

get

https://api.app.gatenox.comhttps://api.sandbox.gatenox.com

/api/v1/verifications

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

outgoing_onlybooleanOptional

true | false

Example: true

incoming_onlybooleanOptional

true | false

Example: true

statusstringOptional

new | in_progress | data_update_requested | qa |completed

Example: new,in_progress

assessment_statusstringOptional

approved | rejected

Example: approved,rejected

created_atstringOptional

YYYY-MM-DD

Example: 2022-07-14

updated_atstringOptional

YYYY-MM-DD

Example: 2022-07-14

company_idstringOptionalExample: e4172e29-8fe6-4977-9776-fdf76ed852b6

company_namestringOptional

string

Example: test

jurisdictionstringOptional

string (alpha2)

Example: gb,pl

order_bystringOptionalExample: updated_at,desc

Responses

200

OK

application/json

get

/api/v1/verifications

HTTPcURLJavaScriptPython

GET /api/v1/verifications HTTP/1.1
Host: api.app.gatenox.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "verifications": [
    {
      "id": "6d04ab71-12ac-4728-bc1c-ae68da6a3513",
      "customer_id": "ext_id_123123",
      "status": "completed",
      "entity_name": "(Demo) Verifier LTD",
      "entity_identifier": "13412213",
      "entity_contact_email": "[email protected]",
      "revision_timestamps": [
        1687508655
      ],
      "created_at": "2023-06-23T08:24:14.879Z",
      "updated_at": "2023-06-23T08:29:58.070Z",
      "access_type": "verifier_compliance_officer",
      "last_data_update": "2023-06-23T08:24:15.000Z",
      "verification_type": "primary",
      "assessment": null,
      "reopen_at": null,
      "assigned_to": null,
      "company_jurisdiction": {
        "id": "f728e115-9301-47e2-996c-0c8d0e39fb10",
        "code": "gb",
        "name": "United Kingdom",
        "country": "United Kingdom",
        "full_name": "United Kingdom"
      }
    }
  ]
}

Details

get

https://api.app.gatenox.comhttps://api.sandbox.gatenox.com

/api/v1/verifications/{id}

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequiredExample: 6d04ab71-12ac-4728-bc1c-ae68da6a3513

Query parameters

timestampintegerOptional

(optional) defaults to newest

Example: 1687508655

Responses

200

OK

application/json

get

/api/v1/verifications/{id}

HTTPcURLJavaScriptPython

GET /api/v1/verifications/{id} HTTP/1.1
Host: api.app.gatenox.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "verification": {
    "id": "6d04ab71-12ac-4728-bc1c-ae68da6a3513",
    "customer_id": "ext_id_123123",
    "status": "completed",
    "entity_name": "(Demo) Verifier LTD",
    "entity_identifier": "13412213",
    "entity_contact_email": "[email protected]",
    "revision_timestamps": [
      1687508655
    ],
    "created_at": "2023-06-23T08:24:14.879Z",
    "updated_at": "2023-06-23T08:29:58.070Z",
    "access_type": "verifier_compliance_officer",
    "last_data_update": "2023-06-23T08:24:15.000Z",
    "verification_type": "primary",
    "assessment": null,
    "reopen_at": null,
    "qa_comment": null,
    "assessment_comment": null,
    "assigned_to": null,
    "external_risk_score": {
      "id": "c02d2b4c-e207-4335-a15a-ceb325f8444f",
      "risk_score_simple": "low",
      "risk_score_detailed": {
        "score": "99%",
        "reasons": [
          "Lorem ipsum dolor sit amet 1",
          "Lorem ipsum dolor sit amet 2"
        ]
      },
      "created_at": "2024-06-14T09:26:46.225Z",
      "updated_at": "2024-06-14T09:34:54.128Z",
      "verification_id": "6d04ab71-12ac-4728-bc1c-ae68da6a3513"
    },
    "company_jurisdiction": {
      "id": "f728e115-9301-47e2-996c-0c8d0e39fb10",
      "code": "gb",
      "name": "United Kingdom",
      "country": "United Kingdom",
      "full_name": "United Kingdom"
    }
  }
}

Upload externally calculated risk score

Update External Risk Score

post

https://api.app.gatenox.comhttps://api.sandbox.gatenox.com

/api/v1/webhooks/external_risk_score

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

multipart/form-data

idstringOptional

uuid

Example: c02d2b4c-e207-4335-a15a-ceb325f8444f

risk_score[simple]stringOptional

(optional) low, medium, high

Example: low

risk_score[detailed][score]stringOptional

string

Example: 99%

risk_score[detailed][reasons][]stringOptional

string

Example: Lorem ipsum dolor sit amet 2

Responses

200

OK

application/json

400

Bad Request

application/json

post

/api/v1/webhooks/external_risk_score

HTTPcURLJavaScriptPython

POST /api/v1/webhooks/external_risk_score HTTP/1.1
Host: api.app.gatenox.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 173

{
  "id": "c02d2b4c-e207-4335-a15a-ceb325f8444f",
  "risk_score[simple]": "low",
  "risk_score[detailed][score]": "99%",
  "risk_score[detailed][reasons][]": "Lorem ipsum dolor sit amet 2"
}

{
  "external_risk_score": {
    "id": "c02d2b4c-e207-4335-a15a-ceb325f8444f",
    "risk_score_simple": "low",
    "risk_score_detailed": {
      "score": "99%",
      "reasons": [
        "Lorem ipsum dolor sit amet 1",
        "Lorem ipsum dolor sit amet 2"
      ]
    },
    "created_at": "2024-06-14T09:26:46.225Z",
    "updated_at": "2024-06-14T09:34:54.128Z",
    "verification_id": "ac6aaa98-d4b4-442f-a465-356b192ec5ac"
  }
}

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

post

https://api.app.gatenox.comhttps://api.sandbox.gatenox.com

/api/v1/verifications/{verification_id}/state/request_data_update

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

/api/v1/verifications/{verification_id}/state/request_data_update

HTTPcURLJavaScriptPython

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

Get details about the company, which sent the application

Company Details

get

https://api.app.gatenox.comhttps://api.sandbox.gatenox.com

/api/v1/verifications/{verification_id}/company_details

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

verification_idstringRequiredExample: 6d04ab71-12ac-4728-bc1c-ae68da6a3513

Query parameters

timestampintegerOptional

(optional) defaults to newest

Example: 1687508655

Responses

200

OK

application/json

400

Bad Request

application/json

get

/api/v1/verifications/{verification_id}/company_details

HTTPcURLJavaScriptPython

GET /api/v1/verifications/{verification_id}/company_details HTTP/1.1
Host: api.app.gatenox.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "company": {
    "id": "f8f658cb-bcca-4253-97cf-4d585c6f9ce8",
    "formal_name": "(Demo) Verifier LTD",
    "brand_name": "(Demo) Verifier",
    "company_number": "13412213",
    "inactive": false,
    "public_stock_exchange": false,
    "date_of_incorporation": "2012-05-04",
    "jurisdiction": {
      "id": "f728e115-9301-47e2-996c-0c8d0e39fb10",
      "code": "gb",
      "name": "United Kingdom",
      "country": "United Kingdom",
      "full_name": "United Kingdom"
    },
    "company_type": {
      "id": "a39f6038-8a5e-48a4-af14-03d46c53b493",
      "short_name": "LTD",
      "full_name": "Private Limited Company",
      "description": "The vast majority of trading companies are private companies limited by shares. There are over two million such companies registered at Companies House. A private company limited by shares must have the word \"Limited\" or \"Ltd\" at the end of its name. The main advantage of trading through a limited company is to have limited liability. Many private companies are very small. There is no minimum capital requirement for a private company and it is commonly less than £100. Approximately 90% of private companies are small or medium sized companies which means that they can file modified (i.e. simplified) accounts at Companies House, rather than full accounts. A private company may not offer shares or debentures to the public: CA 2006, sec755, only a public company (PLC) may do so.",
      "source": null,
      "source_url": null,
      "jurisdiction_code": "gb"
    },
    "industry": {
      "main": {
        "key": 20,
        "value": "Software As A Service",
        "industry": "Digital Products",
        "keywords": [
          "Software",
          "Service"
        ]
      },
      "description": "In quis tincidunt erat. Proin iaculis tempor justo sed ornare. Cras ornare augue ac imperdiet hendrerit.",
      "additional_keys": []
    },
    "activity_description": null,
    "business_description": "Lorem ipsum",
    "products_description": "Lorem ipsum",
    "business_activity_countries": [
      "oceania"
    ],
    "tax_number": "123123",
    "funds_sources": "Private sources",
    "bank_accounts": [
      {
        "id": "d479d657-6681-4063-b85f-e6925e8e99dc",
        "account_holder": "O G",
        "address": "asdasd 123",
        "iban": false,
        "name": "OGs Bank",
        "number": "PL123123123123123",
        "created_at": "2023-06-23T08:23:28.266Z",
        "updated_at": "2023-06-23T08:23:28.266Z"
      }
    ],
    "crypto_addresses": [
      {
        "id": "2ffd3925-dd75-4b30-ab70-c5fe12285058",
        "address": "5GpehigSqpfDRNe8uTyS4BPExw3KuZCS5NfhT6hCVqMkkkMa",
        "address_type": "AZERO",
        "comment": null,
        "signature_message": "916784554ca011520231e56e495e9bf76eca7c2c13445f08237469c73447fe37",
        "signature_verification": "accepted",
        "created_at": "2023-06-23T08:22:39.042Z",
        "updated_at": "2023-06-23T08:22:55.785Z"
      }
    ],
    "website": "www.example.com",
    "phone_number": "12312312",
    "email": "[email protected]",
    "employees_count": "1-5",
    "aml_contact_person": "O G",
    "aml_contact_email": "[email protected]",
    "aml_contact_phone_number": "12312312",
    "opencorporates_url": null,
    "expected_monthly_transactions_volume": null,
    "investigations": false,
    "prosecutions": false,
    "ubo_criminal_records": false,
    "registration_authority": "Companies House",
    "purpose_for_ari10": null,
    "websites_for_ari10": null,
    "license_date_of_expiry": "1900-01-01",
    "license_date_of_issue": "1900-01-01",
    "license_issuing_authority": "undefined",
    "license_number": "undefined",
    "license_required": false,
    "documents_note_from_verifier": null
  },
  "registered_address": {
    "id": "74af8439-e532-43c8-a265-ec60c6493f90",
    "name": "25 Cabot Square",
    "line_1": "25 Cabot Square",
    "line_2": "Canary Wharf Shopping Center",
    "line_3": null,
    "postcode": "E14 4QZ",
    "city": "London",
    "state": null,
    "country": "GB",
    "created_at": "2023-06-22T08:18:26.371Z",
    "updated_at": "2023-06-22T08:18:26.371Z"
  },
  "office_address": {
    "id": "74af8439-e532-43c8-a265-ec60c6493f90",
    "name": "25 Cabot Square",
    "line_1": "25 Cabot Square",
    "line_2": "Canary Wharf Shopping Center",
    "line_3": null,
    "postcode": "E14 4QZ",
    "city": "London",
    "state": null,
    "country": "GB",
    "created_at": "2023-06-22T08:18:26.371Z",
    "updated_at": "2023-06-22T08:18:26.371Z"
  },
  "proof_of_incorporation_details": [
    {
      "id": "c6365534-60b4-4f11-81c9-0c32e25b28f4",
      "purposes": [
        "details_confirmation"
      ],
      "created_at": "2023-06-22T08:18:30.243Z",
      "updated_at": "2023-06-22T08:18:30.243Z",
      "document": {
        "id": "4ca44069-459e-487c-bea4-ddbdac5d584a",
        "country_of_issue": null,
        "name": "Memorandum of Association",
        "number": null,
        "document_type": "other",
        "date_of_issue": null,
        "expiration_date": null,
        "created_at": "2023-06-22T08:18:27.821Z",
        "updated_at": "2023-06-22T08:18:27.821Z",
        "attachments": [
          {
            "id": "63a4d1aa-a2b2-4d3c-87b5-3edab6c67928",
            "attachment_type": "main",
            "created_at": "2023-06-22T08:18:28.264Z",
            "updated_at": "2023-06-22T08:18:31.995Z",
            "filename": "memorandum_of_association.pdf",
            "filesize": 17998,
            "mime": "application/pdf",
            "urls": {
              "thumb": "http://localhost:3000/attachments/eyJpZCI6IjVhNTE0ZDZiMGRkYzFlMTgxMGIxODZlYzkxZDk2MWQxLnBuZyIsInN0b3JhZ2UiOiJ0aHVtYnMiLCJtZXRhZGF0YSI6eyJmaWxlbmFtZSI6ImltYWdlX3Byb2Nlc3NpbmcyMDIzMDYyMi0yMzUzMy00bTZmbjkucG5nIiwic2l6ZSI6MzMyNCwibWltZV90eXBlIjoiaW1hZ2UvcG5nIn19",
              "medium": "http://localhost:3000/attachments/eyJpZCI6ImY2OGY5OTU3YTRkMWNmNmMxNjM0YWI0YjJiNmY2NGZjLnBuZyIsInN0b3JhZ2UiOiJ0aHVtYnMiLCJtZXRhZGF0YSI6eyJmaWxlbmFtZSI6ImltYWdlX3Byb2Nlc3NpbmcyMDIzMDYyMi0yMzUzMy1wMjFnNXYucG5nIiwic2l6ZSI6MjAwMDQsIm1pbWVfdHlwZSI6ImltYWdlL3BuZyJ9fQ",
              "original": "http://localhost:3000/attachments/eyJpZCI6IjM0YmNkZmEzMzMxODViNTI5YWZjMDI4MmQyMjM3OWZlLnBkZiIsInN0b3JhZ2UiOiJzdG9yZSIsIm1ldGFkYXRhIjp7ImZpbGVuYW1lIjoibWVtb3JhbmR1bV9vZl9hc3NvY2lhdGlvbi5wZGYiLCJzaXplIjoxNzk5OCwibWltZV90eXBlIjoiYXBwbGljYXRpb24vcGRmIn19"
            }
          }
        ]
      }
    },
    {
      "id": "623d5546-170a-48f8-a43d-a56cfbb93356",
      "purposes": [
        "details_confirmation"
      ],
      "created_at": "2023-06-22T08:18:30.375Z",
      "updated_at": "2023-06-22T08:18:30.375Z",
      "document": {
        "id": "728947af-be84-4eb6-8f6a-efe6c56649f1",
        "country_of_issue": null,
        "name": "Articles of Association",
        "number": null,
        "document_type": "other",
        "date_of_issue": null,
        "expiration_date": null,
        "created_at": "2023-06-22T08:18:29.118Z",
        "updated_at": "2023-06-22T08:18:29.118Z",
        "attachments": [
          {
            "id": "382404e6-27c7-488d-88cc-2124f74e1759",
            "attachment_type": "main",
            "created_at": "2023-06-22T08:18:29.350Z",
            "updated_at": "2023-06-22T08:18:33.731Z",
            "filename": "articles_of_association.pdf",
            "filesize": 18002,
            "mime": "application/pdf",
            "urls": {
              "thumb": "http://localhost:3000/attachments/eyJpZCI6ImE2NTVjMmZkYmFjMTRhZDVkZGI1YjZlNmMwMmE3ODUwLnBuZyIsInN0b3JhZ2UiOiJ0aHVtYnMiLCJtZXRhZGF0YSI6eyJmaWxlbmFtZSI6ImltYWdlX3Byb2Nlc3NpbmcyMDIzMDYyMi0yMzUzMy10aDV5aDgucG5nIiwic2l6ZSI6MzE2MSwibWltZV90eXBlIjoiaW1hZ2UvcG5nIn19",
              "medium": "http://localhost:3000/attachments/eyJpZCI6IjZjMjRmOTU5NDc4Yzc5MWJiNWFlYzg1OThmZmU1NjBkLnBuZyIsInN0b3JhZ2UiOiJ0aHVtYnMiLCJtZXRhZGF0YSI6eyJmaWxlbmFtZSI6ImltYWdlX3Byb2Nlc3NpbmcyMDIzMDYyMi0yMzUzMy1jOTFtazEucG5nIiwic2l6ZSI6MTg4NDUsIm1pbWVfdHlwZSI6ImltYWdlL3BuZyJ9fQ",
              "original": "http://localhost:3000/attachments/eyJpZCI6Ijk1NjgzYzA0YWUyYTljMGJkMGQ4ZjQ2NzZmMjkxNTk3LnBkZiIsInN0b3JhZ2UiOiJzdG9yZSIsIm1ldGFkYXRhIjp7ImZpbGVuYW1lIjoiYXJ0aWNsZXNfb2ZfYXNzb2NpYXRpb24ucGRmIiwic2l6ZSI6MTgwMDIsIm1pbWVfdHlwZSI6ImFwcGxpY2F0aW9uL3BkZiJ9fQ"
            }
          }
        ]
      }
    }
  ],
  "proof_of_office_address": [
    {
      "id": "7c31b313-73b0-4b1b-a702-dfc0f0ac6357",
      "purposes": [
        "office_address_confirmation"
      ],
      "created_at": "2023-06-22T08:18:30.406Z",
      "updated_at": "2023-06-22T08:18:30.406Z",
      "document": {
        "id": "dd4268da-2624-452f-86b4-47d9e32808ce",
        "country_of_issue": null,
        "name": "Utility bill",
        "number": null,
        "document_type": "other",
        "date_of_issue": null,
        "expiration_date": null,
        "created_at": "2023-06-22T08:18:29.368Z",
        "updated_at": "2023-06-22T08:18:29.368Z",
        "attachments": [
          {
            "id": "7795328d-48ae-413c-b03d-791ec8752cd7",
            "attachment_type": "main",
            "created_at": "2023-06-22T08:18:29.588Z",
            "updated_at": "2023-06-22T08:18:34.270Z",
            "filename": "utility_bill.pdf",
            "filesize": 18200,
            "mime": "application/pdf",
            "urls": {
              "thumb": "http://localhost:3000/attachments/eyJpZCI6IjA1YzQ3YTc5OTcxMDFhMTA0YTRhMWQ2NjVkZmQ4MTQ0LnBuZyIsInN0b3JhZ2UiOiJ0aHVtYnMiLCJtZXRhZGF0YSI6eyJmaWxlbmFtZSI6ImltYWdlX3Byb2Nlc3NpbmcyMDIzMDYyMi0yMzUzMy1tOHBua2UucG5nIiwic2l6ZSI6MjcxMiwibWltZV90eXBlIjoiaW1hZ2UvcG5nIn19",
              "medium": "http://localhost:3000/attachments/eyJpZCI6IjExNzZkMGNiMmMyMzJjMTg1YjY2N2EwM2VkNWZkN2NlLnBuZyIsInN0b3JhZ2UiOiJ0aHVtYnMiLCJtZXRhZGF0YSI6eyJmaWxlbmFtZSI6ImltYWdlX3Byb2Nlc3NpbmcyMDIzMDYyMi0yMzUzMy01dTJzZXkucG5nIiwic2l6ZSI6MTQ2MTIsIm1pbWVfdHlwZSI6ImltYWdlL3BuZyJ9fQ",
              "original": "http://localhost:3000/attachments/eyJpZCI6IjY1YjQzMGQwMmNmM2E5NWZkMTAxYTQwNmZhMTlkMTU0LnBkZiIsInN0b3JhZ2UiOiJzdG9yZSIsIm1ldGFkYXRhIjp7ImZpbGVuYW1lIjoidXRpbGl0eV9iaWxsLnBkZiIsInNpemUiOjE4MjAwLCJtaW1lX3R5cGUiOiJhcHBsaWNhdGlvbi9wZGYifX0"
            }
          }
        ]
      }
    }
  ]
}

Graph

get

https://api.app.gatenox.comhttps://api.sandbox.gatenox.com

/api/v1/verifications/{verification_id}/graph

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

verification_idstringRequiredExample: 6d04ab71-12ac-4728-bc1c-ae68da6a3513

Query parameters

timestampintegerOptional

(optional) defaults to newest

Example: 1687508655

Responses

200

OK

application/json

get

/api/v1/verifications/{verification_id}/graph

HTTPcURLJavaScriptPython

GET /api/v1/verifications/{verification_id}/graph HTTP/1.1
Host: api.app.gatenox.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "graph": {
    "acyclic": true,
    "vertices": [
      {
        "id": "f8f658cb-bcca-4253-97cf-4d585c6f9ce8",
        "type": "Company",
        "labels": {
          "name": "(Demo) Verifier LTD",
          "root": true
        }
      },
      {
        "id": "fcf182e8-072d-4de0-8e75-a0e13b434276",
        "type": "Company",
        "labels": {
          "name": "N3 Enterprises Limited",
          "shareholder": [
            {
              "company_id": "f8f658cb-bcca-4253-97cf-4d585c6f9ce8",
              "shares": 60
            }
          ],
          "calculated_shares": 60
        }
      },
      {
        "id": "646b6c85-faa1-41cd-9341-54d341196051",
        "type": "Person",
        "labels": {
          "given_names": "Joe",
          "surname": "Allen",
          "shareholder": [
            {
              "company_id": "fcf182e8-072d-4de0-8e75-a0e13b434276",
              "shares": 100
            },
            {
              "company_id": "f8f658cb-bcca-4253-97cf-4d585c6f9ce8",
              "shares": 40
            }
          ],
          "ubo": [
            {
              "company_id": "f8f658cb-bcca-4253-97cf-4d585c6f9ce8",
              "shares": 100
            }
          ],
          "director": [
            {
              "company_id": "f8f658cb-bcca-4253-97cf-4d585c6f9ce8",
              "position": "CEO"
            }
          ],
          "calculated_shares": 100
        }
      }
    ],
    "edges": [
      {
        "source": "f8f658cb-bcca-4253-97cf-4d585c6f9ce8",
        "target": "fcf182e8-072d-4de0-8e75-a0e13b434276",
        "labels": {
          "types": [
            "corporate_shareholder"
          ],
          "shares": 60
        }
      },
      {
        "source": "f8f658cb-bcca-4253-97cf-4d585c6f9ce8",
        "target": "646b6c85-faa1-41cd-9341-54d341196051",
        "labels": {
          "types": [
            "individual_shareholder",
            "ubo",
            "director"
          ],
          "shares": 40
        }
      },
      {
        "source": "fcf182e8-072d-4de0-8e75-a0e13b434276",
        "target": "646b6c85-faa1-41cd-9341-54d341196051",
        "labels": {
          "types": [
            "individual_shareholder"
          ],
          "shares": 100
        }
      }
    ]
  }
}

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

List

get

https://api.app.gatenox.comhttps://api.sandbox.gatenox.com

/api/v1/verifications/{verification_id}/people

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

verification_idstringRequiredExample: 6d04ab71-12ac-4728-bc1c-ae68da6a3513

Query parameters

timestampintegerOptional

(optional) defaults to newest

Example: 1687508655

Responses

200

OK

application/json

get

/api/v1/verifications/{verification_id}/people

HTTPcURLJavaScriptPython

GET /api/v1/verifications/{verification_id}/people HTTP/1.1
Host: api.app.gatenox.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "people": [
    {
      "id": "646b6c85-faa1-41cd-9341-54d341196051",
      "surname": "Allen",
      "given_names": "Joe",
      "family_name": null,
      "parents_given_names": null,
      "date_of_birth": "1977-03-10",
      "sex": "male",
      "nationality": "GB",
      "pep": false,
      "pep_description": null,
      "place_of_birth": "GB",
      "personal_number": null,
      "funds_sources": "Private account",
      "email": null,
      "phone": null,
      "title_position": null,
      "created_at": "2023-06-22T08:18:26.414Z",
      "updated_at": "2023-06-22T08:25:21.054Z"
    }
  ]
}

Details

get

https://api.app.gatenox.comhttps://api.sandbox.gatenox.com

/api/v1/verifications/{verification_id}/people/{id}

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

verification_idstringRequiredExample: 6d04ab71-12ac-4728-bc1c-ae68da6a3513

idstringRequiredExample: 646b6c85-faa1-41cd-9341-54d341196051

Query parameters

timestampintegerOptional

(optional) defaults to newest

Example: 1687508655

Responses

200

OK

application/json

get

/api/v1/verifications/{verification_id}/people/{id}

HTTPcURLJavaScriptPython

GET /api/v1/verifications/{verification_id}/people/{id} HTTP/1.1
Host: api.app.gatenox.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "person": {
    "id": "646b6c85-faa1-41cd-9341-54d341196051",
    "surname": "Allen",
    "given_names": "Joe",
    "family_name": null,
    "parents_given_names": null,
    "date_of_birth": "1977-03-10",
    "sex": "male",
    "nationality": "GB",
    "pep": false,
    "pep_description": null,
    "place_of_birth": "GB",
    "personal_number": null,
    "funds_sources": "Private account",
    "email": null,
    "phone": null,
    "title_position": null,
    "created_at": "2023-06-22T08:18:26.414Z",
    "updated_at": "2023-06-22T08:25:21.054Z",
    "address_of_residence": {
      "id": "8d99bde1-21eb-4c5e-8bfb-baa64199f06f",
      "name": "Manilla St",
      "line_1": "Manilla St",
      "line_2": "Apartment 12",
      "line_3": null,
      "postcode": "E14 8GB",
      "city": "London",
      "state": null,
      "country": "GB",
      "created_at": "2023-06-22T08:18:26.390Z",
      "updated_at": "2023-06-22T08:18:26.390Z"
    },
    "address_for_correspondence": null,
    "documents": [
      {
        "id": "d2e79bc6-43cd-4569-a709-f76c24ae9637",
        "purposes": [
          "personal_document"
        ],
        "created_at": "2023-06-22T08:18:27.625Z",
        "updated_at": "2023-06-22T08:18:27.625Z",
        "document": {
          "id": "f6552550-72ae-49e4-b3a2-f7e3d1cac3ea",
          "country_of_issue": "GB",
          "name": "Joe Allen Passport",
          "number": "ABC1234567",
          "document_type": "passport",
          "date_of_issue": "2016-09-20",
          "expiration_date": "2026-09-20",
          "created_at": "2023-06-22T08:18:26.438Z",
          "updated_at": "2023-06-22T08:18:26.438Z",
          "attachments": [
            {
              "id": "ddb90620-ac02-4a6f-96c8-cb86d3baf988",
              "attachment_type": "main",
              "created_at": "2023-06-22T08:18:27.216Z",
              "updated_at": "2023-06-22T08:18:31.110Z",
              "filename": "passport_english.png",
              "filesize": 22237,
              "mime": "image/png",
              "urls": {
                "thumb": "http://localhost:3000/attachments/eyJpZCI6Ijc4Mzg5NGY3ZmNiNmRkMGQxNTc1Y2JmNGViYjBkZGM0LnBuZyIsInN0b3JhZ2UiOiJ0aHVtYnMiLCJtZXRhZGF0YSI6eyJmaWxlbmFtZSI6ImltYWdlX3Byb2Nlc3NpbmcyMDIzMDYyMi0yMzUzMy1ienFxb3EucG5nIiwic2l6ZSI6MTkzMiwibWltZV90eXBlIjoiaW1hZ2UvcG5nIn19",
                "medium": "http://localhost:3000/attachments/eyJpZCI6ImMxM2E1NDE2Mzc3Y2UwZjMzMzM3OWVjZDViZTdmZTIwLnBuZyIsInN0b3JhZ2UiOiJ0aHVtYnMiLCJtZXRhZGF0YSI6eyJmaWxlbmFtZSI6ImltYWdlX3Byb2Nlc3NpbmcyMDIzMDYyMi0yMzUzMy1xOXFwamgucG5nIiwic2l6ZSI6MTA0MjMsIm1pbWVfdHlwZSI6ImltYWdlL3BuZyJ9fQ",
                "original": "http://localhost:3000/attachments/eyJpZCI6ImE5ZTBhMWRlNDc0YjY3NDg1YjUyZjVjNjRmZTE0Y2IxLnBuZyIsInN0b3JhZ2UiOiJzdG9yZSIsIm1ldGFkYXRhIjp7ImZpbGVuYW1lIjoicGFzc3BvcnRfZW5nbGlzaC5wbmciLCJzaXplIjoyMjIzNywibWltZV90eXBlIjoiaW1hZ2UvcG5nIn19"
              }
            }
          ]
        }
      },
      {
        "id": "e6aa957f-01f7-4e25-b56c-804ef06a17dd",
        "purposes": [
          "residence_address_confirmation"
        ],
        "created_at": "2023-06-22T08:18:27.650Z",
        "updated_at": "2023-06-22T08:18:27.650Z",
        "document": {
          "id": "51529e92-f8b0-43b4-b8d8-5d5a8950b483",
          "country_of_issue": null,
          "name": "Utility bill",
          "number": null,
          "document_type": "other",
          "date_of_issue": null,
          "expiration_date": null,
          "created_at": "2023-06-22T08:18:27.274Z",
          "updated_at": "2023-06-22T08:18:27.274Z",
          "attachments": [
            {
              "id": "aaaed8a4-ce23-4c39-bd10-eb7ffb917d5b",
              "attachment_type": "main",
              "created_at": "2023-06-22T08:18:27.583Z",
              "updated_at": "2023-06-22T08:18:31.496Z",
              "filename": "utility_bill.pdf",
              "filesize": 18200,
              "mime": "application/pdf",
              "urls": {
                "thumb": "http://localhost:3000/attachments/eyJpZCI6ImRiOWEyOTdhN2MyZTQyNjZmZGI4YjU3YWNlNWJlYmRiLnBuZyIsInN0b3JhZ2UiOiJ0aHVtYnMiLCJtZXRhZGF0YSI6eyJmaWxlbmFtZSI6ImltYWdlX3Byb2Nlc3NpbmcyMDIzMDYyMi0yMzUzMy1rcmw4NzQucG5nIiwic2l6ZSI6MjcxMiwibWltZV90eXBlIjoiaW1hZ2UvcG5nIn19",
                "medium": "http://localhost:3000/attachments/eyJpZCI6IjE5Y2ZkOGU1YzA1NmJkYzE3MjZlNmE4MmYzZGNiODkyLnBuZyIsInN0b3JhZ2UiOiJ0aHVtYnMiLCJtZXRhZGF0YSI6eyJmaWxlbmFtZSI6ImltYWdlX3Byb2Nlc3NpbmcyMDIzMDYyMi0yMzUzMy12aHYxbW8ucG5nIiwic2l6ZSI6MTQ2MTIsIm1pbWVfdHlwZSI6ImltYWdlL3BuZyJ9fQ",
                "original": "http://localhost:3000/attachments/eyJpZCI6IjAzMWEzMzc1ODMzNWI3ODgxMzg2M2FkZTM1MjAxOGMwLnBkZiIsInN0b3JhZ2UiOiJzdG9yZSIsIm1ldGFkYXRhIjp7ImZpbGVuYW1lIjoidXRpbGl0eV9iaWxsLnBkZiIsInNpemUiOjE4MjAwLCJtaW1lX3R5cGUiOiJhcHBsaWNhdGlvbi9wZGYifX0"
              }
            }
          ]
        }
      }
    ],
    "personal_verification": null
  }
}

List

get

https://api.app.gatenox.comhttps://api.sandbox.gatenox.com

/api/v1/verifications/{verification_id}/companies

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

verification_idstringRequiredExample: 6d04ab71-12ac-4728-bc1c-ae68da6a3513

Query parameters

timestampintegerOptional

(optional) defaults to newest

Example: 1687508655

Responses

200

OK

application/json

get

/api/v1/verifications/{verification_id}/companies

HTTPcURLJavaScriptPython

GET /api/v1/verifications/{verification_id}/companies HTTP/1.1
Host: api.app.gatenox.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "companies": [
    {
      "id": "f8f658cb-bcca-4253-97cf-4d585c6f9ce8",
      "formal_name": "(Demo) Verifier LTD",
      "brand_name": "(Demo) Verifier",
      "company_number": "13412213",
      "inactive": false,
      "public_stock_exchange": false,
      "date_of_incorporation": "2012-05-04",
      "jurisdiction": {
        "id": "f728e115-9301-47e2-996c-0c8d0e39fb10",
        "code": "gb",
        "name": "United Kingdom",
        "country": "United Kingdom",
        "full_name": "United Kingdom"
      },
      "company_type": {
        "id": "a39f6038-8a5e-48a4-af14-03d46c53b493",
        "short_name": "LTD",
        "full_name": "Private Limited Company",
        "description": "The vast majority of trading companies are private companies limited by shares. There are over two million such companies registered at Companies House. A private company limited by shares must have the word \"Limited\" or \"Ltd\" at the end of its name. The main advantage of trading through a limited company is to have limited liability. Many private companies are very small. There is no minimum capital requirement for a private company and it is commonly less than £100. Approximately 90% of private companies are small or medium sized companies which means that they can file modified (i.e. simplified) accounts at Companies House, rather than full accounts. A private company may not offer shares or debentures to the public: CA 2006, sec755, only a public company (PLC) may do so.",
        "source": null,
        "source_url": null,
        "jurisdiction_code": "gb"
      },
      "industry": {
        "main": {
          "key": 20,
          "value": "Software As A Service",
          "industry": "Digital Products",
          "keywords": [
            "Software",
            "Service"
          ]
        },
        "description": "In quis tincidunt erat. Proin iaculis tempor justo sed ornare. Cras ornare augue ac imperdiet hendrerit.",
        "additional_keys": []
      }
    },
    {
      "id": "fcf182e8-072d-4de0-8e75-a0e13b434276",
      "formal_name": "N3 Enterprises Limited",
      "brand_name": null,
      "company_number": "5446174",
      "inactive": null,
      "public_stock_exchange": null,
      "date_of_incorporation": null,
      "jurisdiction": {
        "id": "f728e115-9301-47e2-996c-0c8d0e39fb10",
        "code": "gb",
        "name": "United Kingdom",
        "country": "United Kingdom",
        "full_name": "United Kingdom"
      },
      "company_type": null,
      "industry": {
        "main": null,
        "description": null,
        "additional_keys": null
      }
    }
  ]
}

Details

get

https://api.app.gatenox.comhttps://api.sandbox.gatenox.com

/api/v1/verifications/{verification_id}/companies/{id}

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

verification_idstringRequiredExample: 6d04ab71-12ac-4728-bc1c-ae68da6a3513

idstringRequiredExample: f8f658cb-bcca-4253-97cf-4d585c6f9ce8

Query parameters

timestampintegerOptional

(optional) defaults to newest

Example: 1687508655

Responses

200

OK

application/json

get

/api/v1/verifications/{verification_id}/companies/{id}

HTTPcURLJavaScriptPython

GET /api/v1/verifications/{verification_id}/companies/{id} HTTP/1.1
Host: api.app.gatenox.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "company": {
    "id": "f8f658cb-bcca-4253-97cf-4d585c6f9ce8",
    "formal_name": "(Demo) Verifier LTD",
    "brand_name": "(Demo) Verifier",
    "company_number": "13412213",
    "inactive": false,
    "public_stock_exchange": false,
    "date_of_incorporation": "2012-05-04",
    "jurisdiction": {
      "id": "f728e115-9301-47e2-996c-0c8d0e39fb10",
      "code": "gb",
      "name": "United Kingdom",
      "country": "United Kingdom",
      "full_name": "United Kingdom"
    },
    "company_type": {
      "id": "a39f6038-8a5e-48a4-af14-03d46c53b493",
      "short_name": "LTD",
      "full_name": "Private Limited Company",
      "description": "The vast majority of trading companies are private companies limited by shares. There are over two million such companies registered at Companies House. A private company limited by shares must have the word \"Limited\" or \"Ltd\" at the end of its name. The main advantage of trading through a limited company is to have limited liability. Many private companies are very small. There is no minimum capital requirement for a private company and it is commonly less than £100. Approximately 90% of private companies are small or medium sized companies which means that they can file modified (i.e. simplified) accounts at Companies House, rather than full accounts. A private company may not offer shares or debentures to the public: CA 2006, sec755, only a public company (PLC) may do so.",
      "source": null,
      "source_url": null,
      "jurisdiction_code": "gb"
    },
    "industry": {
      "main": {
        "key": 20,
        "value": "Software As A Service",
        "industry": "Digital Products",
        "keywords": [
          "Software",
          "Service"
        ]
      },
      "description": "In quis tincidunt erat. Proin iaculis tempor justo sed ornare. Cras ornare augue ac imperdiet hendrerit.",
      "additional_keys": []
    },
    "activity_description": null,
    "business_description": "Lorem ipsum",
    "products_description": "Lorem ipsum",
    "business_activity_countries": [
      "oceania"
    ],
    "tax_number": "123123",
    "funds_sources": "Private sources",
    "bank_accounts": [
      {
        "id": "d479d657-6681-4063-b85f-e6925e8e99dc",
        "account_holder": "O G",
        "address": "asdasd 123",
        "iban": false,
        "name": "OGs Bank",
        "number": "PL123123123123123",
        "created_at": "2023-06-23T08:23:28.266Z",
        "updated_at": "2023-06-23T08:23:28.266Z"
      }
    ],
    "crypto_addresses": [
      {
        "id": "2ffd3925-dd75-4b30-ab70-c5fe12285058",
        "address": "5GpehigSqpfDRNe8uTyS4BPExw3KuZCS5NfhT6hCVqMkkkMa",
        "address_type": "AZERO",
        "comment": null,
        "signature_message": "916784554ca011520231e56e495e9bf76eca7c2c13445f08237469c73447fe37",
        "signature_verification": "accepted",
        "created_at": "2023-06-23T08:22:39.042Z",
        "updated_at": "2023-06-23T08:22:55.785Z"
      }
    ],
    "website": "www.example.com",
    "phone_number": "12312312",
    "email": "[email protected]",
    "employees_count": "1-5",
    "aml_contact_person": "O G",
    "aml_contact_email": "[email protected]",
    "aml_contact_phone_number": "12312312",
    "opencorporates_url": null,
    "expected_monthly_transactions_volume": null,
    "investigations": false,
    "prosecutions": false,
    "ubo_criminal_records": false,
    "registration_authority": "Companies House",
    "purpose_for_ari10": null,
    "websites_for_ari10": null,
    "license_date_of_expiry": "1900-01-01",
    "license_date_of_issue": "1900-01-01",
    "license_issuing_authority": "undefined",
    "license_number": "undefined",
    "license_required": false,
    "documents_note_from_verifier": null
  }
}

The list of company directors

List

get

https://api.app.gatenox.comhttps://api.sandbox.gatenox.com

/api/v1/verifications/{verification_id}/directors

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

verification_idstringRequiredExample: 6d04ab71-12ac-4728-bc1c-ae68da6a3513

Query parameters

timestampintegerOptional

(optional) defaults to newest

Example: 1687508655

Responses

200

OK

application/json

get

/api/v1/verifications/{verification_id}/directors

HTTPcURLJavaScriptPython

GET /api/v1/verifications/{verification_id}/directors HTTP/1.1
Host: api.app.gatenox.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "directors": [
    {
      "id": "45f836d7-d374-49cf-aad0-64e45d07394c",
      "position": "CEO",
      "created_at": "2023-06-22T08:18:30.069Z",
      "updated_at": "2023-06-22T08:18:30.069Z",
      "person": {
        "id": "646b6c85-faa1-41cd-9341-54d341196051",
        "surname": "Allen",
        "given_names": "Joe",
        "family_name": null,
        "parents_given_names": null,
        "date_of_birth": "1977-03-10",
        "sex": "male",
        "nationality": "GB",
        "pep": false,
        "pep_description": null,
        "place_of_birth": "GB",
        "personal_number": null,
        "funds_sources": "Private account",
        "email": null,
        "phone": null,
        "title_position": null,
        "created_at": "2023-06-22T08:18:26.414Z",
        "updated_at": "2023-06-22T08:25:21.054Z"
      }
    }
  ]
}

Details

get

https://api.app.gatenox.comhttps://api.sandbox.gatenox.com

/api/v1/verifications/{verification_id}/directors/{id}

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

verification_idstringRequiredExample: 6d04ab71-12ac-4728-bc1c-ae68da6a3513

idstringRequiredExample: 45f836d7-d374-49cf-aad0-64e45d07394c

Query parameters

timestampintegerOptional

(optional) defaults to newest

Example: 1687508655

Responses

200

OK

application/json

get

/api/v1/verifications/{verification_id}/directors/{id}

HTTPcURLJavaScriptPython

GET /api/v1/verifications/{verification_id}/directors/{id} HTTP/1.1
Host: api.app.gatenox.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "director": {
    "id": "45f836d7-d374-49cf-aad0-64e45d07394c",
    "position": "CEO",
    "created_at": "2023-06-22T08:18:30.069Z",
    "updated_at": "2023-06-22T08:18:30.069Z",
    "person": {
      "id": "646b6c85-faa1-41cd-9341-54d341196051",
      "surname": "Allen",
      "given_names": "Joe",
      "family_name": null,
      "parents_given_names": null,
      "date_of_birth": "1977-03-10",
      "sex": "male",
      "nationality": "GB",
      "pep": false,
      "pep_description": null,
      "place_of_birth": "GB",
      "personal_number": null,
      "funds_sources": "Private account",
      "email": null,
      "phone": null,
      "title_position": null,
      "created_at": "2023-06-22T08:18:26.414Z",
      "updated_at": "2023-06-22T08:25:21.054Z",
      "address_of_residence": {
        "id": "8d99bde1-21eb-4c5e-8bfb-baa64199f06f",
        "name": "Manilla St",
        "line_1": "Manilla St",
        "line_2": "Apartment 12",
        "line_3": null,
        "postcode": "E14 8GB",
        "city": "London",
        "state": null,
        "country": "GB",
        "created_at": "2023-06-22T08:18:26.390Z",
        "updated_at": "2023-06-22T08:18:26.390Z"
      },
      "address_for_correspondence": null,
      "documents": [
        {
          "id": "d2e79bc6-43cd-4569-a709-f76c24ae9637",
          "purposes": [
            "personal_document"
          ],
          "created_at": "2023-06-22T08:18:27.625Z",
          "updated_at": "2023-06-22T08:18:27.625Z",
          "document": {
            "id": "f6552550-72ae-49e4-b3a2-f7e3d1cac3ea",
            "country_of_issue": "GB",
            "name": "Joe Allen Passport",
            "number": "ABC1234567",
            "document_type": "passport",
            "date_of_issue": "2016-09-20",
            "expiration_date": "2026-09-20",
            "created_at": "2023-06-22T08:18:26.438Z",
            "updated_at": "2023-06-22T08:18:26.438Z",
            "attachments": [
              {
                "id": "ddb90620-ac02-4a6f-96c8-cb86d3baf988",
                "attachment_type": "main",
                "created_at": "2023-06-22T08:18:27.216Z",
                "updated_at": "2023-06-22T08:18:31.110Z",
                "filename": "passport_english.png",
                "filesize": 22237,
                "mime": "image/png",
                "urls": {
                  "thumb": "http://localhost:3000/attachments/eyJpZCI6Ijc4Mzg5NGY3ZmNiNmRkMGQxNTc1Y2JmNGViYjBkZGM0LnBuZyIsInN0b3JhZ2UiOiJ0aHVtYnMiLCJtZXRhZGF0YSI6eyJmaWxlbmFtZSI6ImltYWdlX3Byb2Nlc3NpbmcyMDIzMDYyMi0yMzUzMy1ienFxb3EucG5nIiwic2l6ZSI6MTkzMiwibWltZV90eXBlIjoiaW1hZ2UvcG5nIn19",
                  "medium": "http://localhost:3000/attachments/eyJpZCI6ImMxM2E1NDE2Mzc3Y2UwZjMzMzM3OWVjZDViZTdmZTIwLnBuZyIsInN0b3JhZ2UiOiJ0aHVtYnMiLCJtZXRhZGF0YSI6eyJmaWxlbmFtZSI6ImltYWdlX3Byb2Nlc3NpbmcyMDIzMDYyMi0yMzUzMy1xOXFwamgucG5nIiwic2l6ZSI6MTA0MjMsIm1pbWVfdHlwZSI6ImltYWdlL3BuZyJ9fQ",
                  "original": "http://localhost:3000/attachments/eyJpZCI6ImE5ZTBhMWRlNDc0YjY3NDg1YjUyZjVjNjRmZTE0Y2IxLnBuZyIsInN0b3JhZ2UiOiJzdG9yZSIsIm1ldGFkYXRhIjp7ImZpbGVuYW1lIjoicGFzc3BvcnRfZW5nbGlzaC5wbmciLCJzaXplIjoyMjIzNywibWltZV90eXBlIjoiaW1hZ2UvcG5nIn19"
                }
              }
            ]
          }
        },
        {
          "id": "e6aa957f-01f7-4e25-b56c-804ef06a17dd",
          "purposes": [
            "residence_address_confirmation"
          ],
          "created_at": "2023-06-22T08:18:27.650Z",
          "updated_at": "2023-06-22T08:18:27.650Z",
          "document": {
            "id": "51529e92-f8b0-43b4-b8d8-5d5a8950b483",
            "country_of_issue": null,
            "name": "Utility bill",
            "number": null,
            "document_type": "other",
            "date_of_issue": null,
            "expiration_date": null,
            "created_at": "2023-06-22T08:18:27.274Z",
            "updated_at": "2023-06-22T08:18:27.274Z",
            "attachments": [
              {
                "id": "aaaed8a4-ce23-4c39-bd10-eb7ffb917d5b",
                "attachment_type": "main",
                "created_at": "2023-06-22T08:18:27.583Z",
                "updated_at": "2023-06-22T08:18:31.496Z",
                "filename": "utility_bill.pdf",
                "filesize": 18200,
                "mime": "application/pdf",
                "urls": {
                  "thumb": "http://localhost:3000/attachments/eyJpZCI6ImRiOWEyOTdhN2MyZTQyNjZmZGI4YjU3YWNlNWJlYmRiLnBuZyIsInN0b3JhZ2UiOiJ0aHVtYnMiLCJtZXRhZGF0YSI6eyJmaWxlbmFtZSI6ImltYWdlX3Byb2Nlc3NpbmcyMDIzMDYyMi0yMzUzMy1rcmw4NzQucG5nIiwic2l6ZSI6MjcxMiwibWltZV90eXBlIjoiaW1hZ2UvcG5nIn19",
                  "medium": "http://localhost:3000/attachments/eyJpZCI6IjE5Y2ZkOGU1YzA1NmJkYzE3MjZlNmE4MmYzZGNiODkyLnBuZyIsInN0b3JhZ2UiOiJ0aHVtYnMiLCJtZXRhZGF0YSI6eyJmaWxlbmFtZSI6ImltYWdlX3Byb2Nlc3NpbmcyMDIzMDYyMi0yMzUzMy12aHYxbW8ucG5nIiwic2l6ZSI6MTQ2MTIsIm1pbWVfdHlwZSI6ImltYWdlL3BuZyJ9fQ",
                  "original": "http://localhost:3000/attachments/eyJpZCI6IjAzMWEzMzc1ODMzNWI3ODgxMzg2M2FkZTM1MjAxOGMwLnBkZiIsInN0b3JhZ2UiOiJzdG9yZSIsIm1ldGFkYXRhIjp7ImZpbGVuYW1lIjoidXRpbGl0eV9iaWxsLnBkZiIsInNpemUiOjE4MjAwLCJtaW1lX3R5cGUiOiJhcHBsaWNhdGlvbi9wZGYifX0"
                }
              }
            ]
          }
        }
      ],
      "personal_verification": null
    }
  }
}

The list of UBOs

List

get

https://api.app.gatenox.comhttps://api.sandbox.gatenox.com

/api/v1/verifications/{verification_id}/ubos

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

verification_idstringRequiredExample: 6d04ab71-12ac-4728-bc1c-ae68da6a3513

Query parameters

timestampintegerOptional

(optional) defaults to newest

Example: 1687508655

Responses

200

OK

application/json

get

/api/v1/verifications/{verification_id}/ubos

HTTPcURLJavaScriptPython

GET /api/v1/verifications/{verification_id}/ubos HTTP/1.1
Host: api.app.gatenox.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "ubos": [
    {
      "id": "6d61b492-e05a-4acc-a7bf-0e774793bfa1",
      "approximate_percentage_of_shares": 100,
      "description": "The person owns at least 25% of share capital",
      "natures_of_control": [],
      "created_at": "2023-06-22T08:18:30.196Z",
      "updated_at": "2023-06-22T08:18:30.196Z",
      "person": {
        "id": "646b6c85-faa1-41cd-9341-54d341196051",
        "surname": "Allen",
        "given_names": "Joe",
        "family_name": null,
        "parents_given_names": null,
        "date_of_birth": "1977-03-10",
        "sex": "male",
        "nationality": "GB",
        "pep": false,
        "pep_description": null,
        "place_of_birth": "GB",
        "personal_number": null,
        "funds_sources": "Private account",
        "email": null,
        "phone": null,
        "title_position": null,
        "created_at": "2023-06-22T08:18:26.414Z",
        "updated_at": "2023-06-22T08:25:21.054Z"
      }
    }
  ]
}

Details

get

https://api.app.gatenox.comhttps://api.sandbox.gatenox.com

/api/v1/verifications/{verification_id}/ubos/{id}

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

verification_idstringRequiredExample: 6d04ab71-12ac-4728-bc1c-ae68da6a3513

idstringRequiredExample: 6d61b492-e05a-4acc-a7bf-0e774793bfa1

Query parameters

timestampintegerOptional

(optional) defaults to newest

Example: 1687508655

Responses

200

OK

application/json

get

/api/v1/verifications/{verification_id}/ubos/{id}

HTTPcURLJavaScriptPython

GET /api/v1/verifications/{verification_id}/ubos/{id} HTTP/1.1
Host: api.app.gatenox.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "ubo": {
    "id": "6d61b492-e05a-4acc-a7bf-0e774793bfa1",
    "approximate_percentage_of_shares": 100,
    "description": "The person owns at least 25% of share capital",
    "natures_of_control": [],
    "created_at": "2023-06-22T08:18:30.196Z",
    "updated_at": "2023-06-22T08:18:30.196Z",
    "person": {
      "id": "646b6c85-faa1-41cd-9341-54d341196051",
      "surname": "Allen",
      "given_names": "Joe",
      "family_name": null,
      "parents_given_names": null,
      "date_of_birth": "1977-03-10",
      "sex": "male",
      "nationality": "GB",
      "pep": false,
      "pep_description": null,
      "place_of_birth": "GB",
      "personal_number": null,
      "funds_sources": "Private account",
      "email": null,
      "phone": null,
      "title_position": null,
      "created_at": "2023-06-22T08:18:26.414Z",
      "updated_at": "2023-06-22T08:25:21.054Z",
      "address_of_residence": {
        "id": "8d99bde1-21eb-4c5e-8bfb-baa64199f06f",
        "name": "Manilla St",
        "line_1": "Manilla St",
        "line_2": "Apartment 12",
        "line_3": null,
        "postcode": "E14 8GB",
        "city": "London",
        "state": null,
        "country": "GB",
        "created_at": "2023-06-22T08:18:26.390Z",
        "updated_at": "2023-06-22T08:18:26.390Z"
      },
      "address_for_correspondence": null,
      "documents": [
        {
          "id": "d2e79bc6-43cd-4569-a709-f76c24ae9637",
          "purposes": [
            "personal_document"
          ],
          "created_at": "2023-06-22T08:18:27.625Z",
          "updated_at": "2023-06-22T08:18:27.625Z",
          "document": {
            "id": "f6552550-72ae-49e4-b3a2-f7e3d1cac3ea",
            "country_of_issue": "GB",
            "name": "Joe Allen Passport",
            "number": "ABC1234567",
            "document_type": "passport",
            "date_of_issue": "2016-09-20",
            "expiration_date": "2026-09-20",
            "created_at": "2023-06-22T08:18:26.438Z",
            "updated_at": "2023-06-22T08:18:26.438Z",
            "attachments": [
              {
                "id": "ddb90620-ac02-4a6f-96c8-cb86d3baf988",
                "attachment_type": "main",
                "created_at": "2023-06-22T08:18:27.216Z",
                "updated_at": "2023-06-22T08:18:31.110Z",
                "filename": "passport_english.png",
                "filesize": 22237,
                "mime": "image/png",
                "urls": {
                  "thumb": "http://localhost:3000/attachments/eyJpZCI6Ijc4Mzg5NGY3ZmNiNmRkMGQxNTc1Y2JmNGViYjBkZGM0LnBuZyIsInN0b3JhZ2UiOiJ0aHVtYnMiLCJtZXRhZGF0YSI6eyJmaWxlbmFtZSI6ImltYWdlX3Byb2Nlc3NpbmcyMDIzMDYyMi0yMzUzMy1ienFxb3EucG5nIiwic2l6ZSI6MTkzMiwibWltZV90eXBlIjoiaW1hZ2UvcG5nIn19",
                  "medium": "http://localhost:3000/attachments/eyJpZCI6ImMxM2E1NDE2Mzc3Y2UwZjMzMzM3OWVjZDViZTdmZTIwLnBuZyIsInN0b3JhZ2UiOiJ0aHVtYnMiLCJtZXRhZGF0YSI6eyJmaWxlbmFtZSI6ImltYWdlX3Byb2Nlc3NpbmcyMDIzMDYyMi0yMzUzMy1xOXFwamgucG5nIiwic2l6ZSI6MTA0MjMsIm1pbWVfdHlwZSI6ImltYWdlL3BuZyJ9fQ",
                  "original": "http://localhost:3000/attachments/eyJpZCI6ImE5ZTBhMWRlNDc0YjY3NDg1YjUyZjVjNjRmZTE0Y2IxLnBuZyIsInN0b3JhZ2UiOiJzdG9yZSIsIm1ldGFkYXRhIjp7ImZpbGVuYW1lIjoicGFzc3BvcnRfZW5nbGlzaC5wbmciLCJzaXplIjoyMjIzNywibWltZV90eXBlIjoiaW1hZ2UvcG5nIn19"
                }
              }
            ]
          }
        },
        {
          "id": "e6aa957f-01f7-4e25-b56c-804ef06a17dd",
          "purposes": [
            "residence_address_confirmation"
          ],
          "created_at": "2023-06-22T08:18:27.650Z",
          "updated_at": "2023-06-22T08:18:27.650Z",
          "document": {
            "id": "51529e92-f8b0-43b4-b8d8-5d5a8950b483",
            "country_of_issue": null,
            "name": "Utility bill",
            "number": null,
            "document_type": "other",
            "date_of_issue": null,
            "expiration_date": null,
            "created_at": "2023-06-22T08:18:27.274Z",
            "updated_at": "2023-06-22T08:18:27.274Z",
            "attachments": [
              {
                "id": "aaaed8a4-ce23-4c39-bd10-eb7ffb917d5b",
                "attachment_type": "main",
                "created_at": "2023-06-22T08:18:27.583Z",
                "updated_at": "2023-06-22T08:18:31.496Z",
                "filename": "utility_bill.pdf",
                "filesize": 18200,
                "mime": "application/pdf",
                "urls": {
                  "thumb": "http://localhost:3000/attachments/eyJpZCI6ImRiOWEyOTdhN2MyZTQyNjZmZGI4YjU3YWNlNWJlYmRiLnBuZyIsInN0b3JhZ2UiOiJ0aHVtYnMiLCJtZXRhZGF0YSI6eyJmaWxlbmFtZSI6ImltYWdlX3Byb2Nlc3NpbmcyMDIzMDYyMi0yMzUzMy1rcmw4NzQucG5nIiwic2l6ZSI6MjcxMiwibWltZV90eXBlIjoiaW1hZ2UvcG5nIn19",
                  "medium": "http://localhost:3000/attachments/eyJpZCI6IjE5Y2ZkOGU1YzA1NmJkYzE3MjZlNmE4MmYzZGNiODkyLnBuZyIsInN0b3JhZ2UiOiJ0aHVtYnMiLCJtZXRhZGF0YSI6eyJmaWxlbmFtZSI6ImltYWdlX3Byb2Nlc3NpbmcyMDIzMDYyMi0yMzUzMy12aHYxbW8ucG5nIiwic2l6ZSI6MTQ2MTIsIm1pbWVfdHlwZSI6ImltYWdlL3BuZyJ9fQ",
                  "original": "http://localhost:3000/attachments/eyJpZCI6IjAzMWEzMzc1ODMzNWI3ODgxMzg2M2FkZTM1MjAxOGMwLnBkZiIsInN0b3JhZ2UiOiJzdG9yZSIsIm1ldGFkYXRhIjp7ImZpbGVuYW1lIjoidXRpbGl0eV9iaWxsLnBkZiIsInNpemUiOjE4MjAwLCJtaW1lX3R5cGUiOiJhcHBsaWNhdGlvbi9wZGYifX0"
                }
              }
            ]
          }
        }
      ],
      "personal_verification": null
    }
  }
}

Company documents

List

get

https://api.app.gatenox.comhttps://api.sandbox.gatenox.com

/api/v1/verifications/{verification_id}/company_documents

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

verification_idstringRequiredExample: 6d04ab71-12ac-4728-bc1c-ae68da6a3513

Query parameters

timestampintegerOptional

(optional) defaults to newest

Example: 1687508655

Responses

200

OK

application/json

get

/api/v1/verifications/{verification_id}/company_documents

HTTPcURLJavaScriptPython

GET /api/v1/verifications/{verification_id}/company_documents HTTP/1.1
Host: api.app.gatenox.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "company_documents": [
    {
      "id": "c6365534-60b4-4f11-81c9-0c32e25b28f4",
      "purposes": [
        "details_confirmation"
      ],
      "created_at": "2023-06-22T08:18:30.243Z",
      "updated_at": "2023-06-22T08:18:30.243Z",
      "document": {
        "id": "4ca44069-459e-487c-bea4-ddbdac5d584a",
        "country_of_issue": null,
        "name": "Memorandum of Association",
        "number": null,
        "document_type": "other",
        "date_of_issue": null,
        "expiration_date": null,
        "created_at": "2023-06-22T08:18:27.821Z",
        "updated_at": "2023-06-22T08:18:27.821Z",
        "attachments": [
          {
            "id": "63a4d1aa-a2b2-4d3c-87b5-3edab6c67928",
            "attachment_type": "main",
            "created_at": "2023-06-22T08:18:28.264Z",
            "updated_at": "2023-06-22T08:18:31.995Z",
            "filename": "memorandum_of_association.pdf",
            "filesize": 17998,
            "mime": "application/pdf",
            "urls": {
              "thumb": "http://localhost:3000/attachments/eyJpZCI6IjVhNTE0ZDZiMGRkYzFlMTgxMGIxODZlYzkxZDk2MWQxLnBuZyIsInN0b3JhZ2UiOiJ0aHVtYnMiLCJtZXRhZGF0YSI6eyJmaWxlbmFtZSI6ImltYWdlX3Byb2Nlc3NpbmcyMDIzMDYyMi0yMzUzMy00bTZmbjkucG5nIiwic2l6ZSI6MzMyNCwibWltZV90eXBlIjoiaW1hZ2UvcG5nIn19",
              "medium": "http://localhost:3000/attachments/eyJpZCI6ImY2OGY5OTU3YTRkMWNmNmMxNjM0YWI0YjJiNmY2NGZjLnBuZyIsInN0b3JhZ2UiOiJ0aHVtYnMiLCJtZXRhZGF0YSI6eyJmaWxlbmFtZSI6ImltYWdlX3Byb2Nlc3NpbmcyMDIzMDYyMi0yMzUzMy1wMjFnNXYucG5nIiwic2l6ZSI6MjAwMDQsIm1pbWVfdHlwZSI6ImltYWdlL3BuZyJ9fQ",
              "original": "http://localhost:3000/attachments/eyJpZCI6IjM0YmNkZmEzMzMxODViNTI5YWZjMDI4MmQyMjM3OWZlLnBkZiIsInN0b3JhZ2UiOiJzdG9yZSIsIm1ldGFkYXRhIjp7ImZpbGVuYW1lIjoibWVtb3JhbmR1bV9vZl9hc3NvY2lhdGlvbi5wZGYiLCJzaXplIjoxNzk5OCwibWltZV90eXBlIjoiYXBwbGljYXRpb24vcGRmIn19"
            }
          }
        ]
      }
    }
  ]
}

Details

get

https://api.app.gatenox.comhttps://api.sandbox.gatenox.com

/api/v1/verifications/{verification_id}/company_documents/{id}

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

verification_idstringRequiredExample: 6d04ab71-12ac-4728-bc1c-ae68da6a3513

idstringRequiredExample: c6365534-60b4-4f11-81c9-0c32e25b28f4

Query parameters

timestampintegerOptional

(optional) defaults to newest

Example: 1687508655

Responses

200

OK

application/json

get

/api/v1/verifications/{verification_id}/company_documents/{id}

HTTPcURLJavaScriptPython

GET /api/v1/verifications/{verification_id}/company_documents/{id} HTTP/1.1
Host: api.app.gatenox.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "company_document": {
    "id": "c6365534-60b4-4f11-81c9-0c32e25b28f4",
    "purposes": [
      "details_confirmation"
    ],
    "created_at": "2023-06-22T08:18:30.243Z",
    "updated_at": "2023-06-22T08:18:30.243Z",
    "document": {
      "id": "4ca44069-459e-487c-bea4-ddbdac5d584a",
      "country_of_issue": null,
      "name": "Memorandum of Association",
      "number": null,
      "document_type": "other",
      "date_of_issue": null,
      "expiration_date": null,
      "created_at": "2023-06-22T08:18:27.821Z",
      "updated_at": "2023-06-22T08:18:27.821Z",
      "attachments": [
        {
          "id": "63a4d1aa-a2b2-4d3c-87b5-3edab6c67928",
          "attachment_type": "main",
          "created_at": "2023-06-22T08:18:28.264Z",
          "updated_at": "2023-06-22T08:18:31.995Z",
          "filename": "memorandum_of_association.pdf",
          "filesize": 17998,
          "mime": "application/pdf",
          "urls": {
            "thumb": "http://localhost:3000/attachments/eyJpZCI6IjVhNTE0ZDZiMGRkYzFlMTgxMGIxODZlYzkxZDk2MWQxLnBuZyIsInN0b3JhZ2UiOiJ0aHVtYnMiLCJtZXRhZGF0YSI6eyJmaWxlbmFtZSI6ImltYWdlX3Byb2Nlc3NpbmcyMDIzMDYyMi0yMzUzMy00bTZmbjkucG5nIiwic2l6ZSI6MzMyNCwibWltZV90eXBlIjoiaW1hZ2UvcG5nIn19",
            "medium": "http://localhost:3000/attachments/eyJpZCI6ImY2OGY5OTU3YTRkMWNmNmMxNjM0YWI0YjJiNmY2NGZjLnBuZyIsInN0b3JhZ2UiOiJ0aHVtYnMiLCJtZXRhZGF0YSI6eyJmaWxlbmFtZSI6ImltYWdlX3Byb2Nlc3NpbmcyMDIzMDYyMi0yMzUzMy1wMjFnNXYucG5nIiwic2l6ZSI6MjAwMDQsIm1pbWVfdHlwZSI6ImltYWdlL3BuZyJ9fQ",
            "original": "http://localhost:3000/attachments/eyJpZCI6IjM0YmNkZmEzMzMxODViNTI5YWZjMDI4MmQyMjM3OWZlLnBkZiIsInN0b3JhZ2UiOiJzdG9yZSIsIm1ldGFkYXRhIjp7ImZpbGVuYW1lIjoibWVtb3JhbmR1bV9vZl9hc3NvY2lhdGlvbi5wZGYiLCJzaXplIjoxNzk5OCwibWltZV90eXBlIjoiYXBwbGljYXRpb24vcGRmIn19"
          }
        }
      ]
    }
  }
}

Download Attachement

get

https://api.app.gatenox.comhttps://api.sandbox.gatenox.com

/api/v1/attachments/{rest}

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

reststringRequiredExample: eyJpZCI6ImI4NmQyMTE4NmU2YmZiNmM5Mjg2ZWNiOTU0N2JhYzNlLnBkZiIsInN0b3JhZ2UiOiJzdG9yZSIsIm1ldGFkYXRhIjp7ImZpbGVuYW1lIjpudWxsLCJzaXplIjoxNzYzNTYsIm1pbWVfdHlwZSI6ImFwcGxpY2F0aW9uL3BkZiJ9fQ

Responses

200

Successful response

application/json

get

/api/v1/attachments/{rest}

HTTPcURLJavaScriptPython

GET /api/v1/attachments/{rest} HTTP/1.1
Host: api.app.gatenox.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response