bronID logobronID logo

Follow-up info request

Sometimes customers don't provide enough information to complete the verification of an entity. When this happens, you will receive the verificationStatus: info webhook to let you know that there is missing information. The missing information can only be regarding individuals or documents related to the entity.

This page is regarding the KYC API follow-up info request. If you are looking for the Forms API follow-up info request, you can find it here.

Sample incoming webhook

{
    /* this status tells us there is missing information */
    "verificationStatus": "info",
    /* we will need to use this parameter in our API call */
    "verificationUuid": "cd0c518f-7084-49ff-802a-9c517245daf2",
    "trace": "cd0c518f-7084-49ff-802a-9c517245daf2",
    "entityType": "association",
    "name": "THE ENTITY NAME",
    "timestamp": 1583455152245,
    "idvRiskScore": {
        "description": "Medium",
    },

    /* requestedActions tells us what information is missing */
    "requestedActions": [
        {
            /* missing individual */
            "type": "individual",
            /* the role of the individual */
            "role": "shareholders",
            /* we will use the "id" to submit the details of this individual */
            "id": "5ad6b33c-44f1-4b12-9ec9-31fadd41f6c3",
            /* details of the individual */
            "fields": {
                "country": "AUS",
                "firstName": "Jane",
                "lastName": "Citizen",
                "middleName": ""
            }
        },
        {
            /* missing document */
            "type": "document",
            /* the name of the requested document */
			"extractType": "Trust Deed for My Entity"
            /* we will use the "id" to submit the document */
            "id": "edfff080-8637-454a-9c5d-e2d3f6710ffc"
        }
    ]
}

Note on requested individuals

When we request an individual in an Info webhook, expect all potential stakeholder roles, not only those relevant to a specific entity type. This is because the KYB you submitted may contain a nested entity of a different type. Stakeholders can hold any of the following roles: beneficiaries; directors; individuals; partners; publicOfficer; settlors; shareholders; trustee

Note on requested documents

Requested documents must be submitted in PDF, JPG, or PNG format only, with a maximum file size of 25 MB per document.

Submitting missing information

After you have collected the missing KYC information submit it to the /verify endpoint.

Runnable example

POST
/verify
// api endpoint
const apiEndpoint = 'https://dev.bronid.com/verify';

// request body
const data = {
  "metadata_serviceUid": "yourServiceUid",
  "metadata_secretKey": "yourSecretKey",
  "metadata_version": "4",

  /* this needs to match the verificationUuid with status info */
  "verificationUuid": "cd0c518f-7084-49ff-802a-9c517245daf2",

  "requestedActions": [
  {
  	/* missing individual */
      "type": "individual",
  	/* match the role */
      "role": "shareholders",
  	/* match the id */
      "id": "5ad6b33c-44f1-4b12-9ec9-31fadd41f6c3",
  	/* KYC details of the missing individual */
      "fields": {
          "country": "AUS",
          "firstName": "Jane",
          "lastName": "Citizen",
          "middleName": "",
          "gender": "female",
          "dateOfBirth": "20/12/1980",
          "unitNumber": "1",
          "streetNumber": "94",
          "streetName": "Lennox",
          "streetType": "Street",
          "suburb": "CASINO",
          "postcode": "2470",
          "state": "NSW",
          "email": "email@gmail.com"
      }
  },
  {
  	/* missing document */
      "type": "document",
  	/* match the id */
      "id": "edfff080-8637-454a-9c5d-e2d3f6710ffc",
  	/* base64 of the document */
      "documentBase64": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg=="
  }

]
};

try {
  const response = await fetch(apiEndpoint, {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
    },
    body: JSON.stringify(data),
  });

  if (!response.ok) {
    const errorData = await response.json();
    console.log('error! click the results to expand them');
    console.log(JSON.stringify(errorData, null, 2));
  } else {
    const result = await response.json();
    const printResult = 'bronId API response: ' + JSON.stringify(result, null, 2);
    console.log(printResult);
  }
} catch (error) {
  console.log('Fetch error: ', error);
}