CoP | Documentation

Fetch Name Check Using Bulk in common API

GET /v1.1/accounts-verifications/{id}

The API allows us to fetch the response of a particular file that had been processed earlier in bulk upload name verification. By using the id returned by the bulk name verification request, the user will be able to download this response report.

Request Headers

Attribute	Type	Condition	Description
Authorization	String	Mandatory	An authorisation token as per https://tools.ietf.org/html/rfc6750
transaction-XRef-Id	UUID	Optional	Unique Id sent by the requester for every request in UUID4 format for cross reference purpose.

Request Parameters

Attribute	Type	Condition	Description
transaction-XRef-Id	UUID	Mandatory	Unique Id sent by the requester for every request in UUID4 format for cross reference purpose.

Response Headers

Attribute	Type	Condition	Description
transaction-XRef-Id	UUID	Mandatory	Unique Id sent by the requester for every request in UUID4 format for cross reference purpose.

Response Body

Attribute	Type	Condition	Description
bulkResult	Object	Mandatory	Verification report bulk result summary
id	String	Mandatory	The unique transaction id reference related with a previous POST account verification request, provided as path parameter in the request
xRefId	String	Optional	Unique Id sent by the requester for each account verification in UUID4 format for cross reference purpose
message	String	Optional	A confirmation message sent
status	String	Mandatory	Indicates the report status COMPLETE: The account verification request has been complete, and the report is available PENDING: The account verification request still in process and the report is not available yet

Response Codes

Status Code	Description
200	Account verification response received successfully
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
408	Request Timeout
421	Misdirected Request
429	Too Many Requests
500	Internal Server Error
503	Service Unavailable

Examples:

All success responses - 4 checks [Full Match, PAMM, ANNM, AC01]

Request

{
  "data": {
    "query": [
        {
          "xRefId": "f1791b7a-6fb1-4a3d-b6c0-9bf1b03e2f9e",
          "types": ["NAME"],
          "account": {
            "type": "PERSONAL",
            "idScheme": "SCAN",
            "id": "10000022456709",
            "name": "Michael Nicholas"
          }
        },
        {
          "xRefId": "c3e56d49-87f2-4d2b-b73a-61e8b2e3f4fa",
          "types": ["NAME"],
          "account": {
            "type": "BUSINESS",
            "idScheme": "SCAN",
            "id": "30000099678911",
            "name": "Jonathan Smit"
          }
        },
        {
          "xRefId": "a8e81f7e-5c11-47b7-9981-1b5fb1a81932",
          "types": ["NAME"],
          "account": {
            "type": "BUSINESS",
            "idScheme": "SCAN",
            "id": "30000099678911",
            "name": "Jonathan Smit"
          }
        },
        {
          "xRefId": "r7e00w7e-5c11-47b7-9981-1b5fb1a37482",
          "types": ["NAME"],
          "account": {
            "type": "PERSONAL",
            "idScheme": "SCAN",
            "id": "30000010030004",
            "name": "Joan Rivers"
          }
        }
    ]
  }
}

Response

{
  "data": {
    "bulkResult": {
      "id": "ec8ec8ce-49ac-4ea5-a310-f2f14d47a8e8",
      "xRefId": "<string>",
      "message": "Verification has been finished.",
      "status": "COMPLETE"
    },
    "result": [
      {
        "reportStatus": "COMPLETE",
        "account": {
          "id": "30000099678911",
          "nameCheckStatus": "FULL_MATCH"
        },
        "responder": {
          "accountVerificationScheme": "UK_COP",
          "apiVersion": "2.0.0",
          "urlVerificationScheme": "https://portal.leatherback-cop-sbx.banfico.io/documentation/api-specifications/confirmation-of-payee-v2.0",
          "schemeResponseCodes": [],
          "entity": {
            "idType": "PARTICIPANT_ORG_ID",
            "idValue": "N9QOI4uiKOeUp8qa66"
          }
        }
      },
      {
        "reportStatus": "COMPLETE",
        "account": {
          "id": "30000010030004"
        },
        "responder": {
          "accountVerificationScheme": "UK_COP",
          "apiVersion": "2.0.0",
          "urlVerificationScheme": "https://portal.leatherback-cop-sbx.banfico.io/documentation/api-specifications/confirmation-of-payee-v2.0",
          "schemeResponseCodes": ["PAMM"],
          "entity": {
            "idType": "PARTICIPANT_ORG_ID",
            "idValue": "N9QOI4uiKOeUp8qa66"
          }
        }
      },
      {
        "reportStatus": "COMPLETE",
        "account": {
          "id": "10000022456709"
        },
        "responder": {
          "accountVerificationScheme": "UK_COP",
          "apiVersion": "2.0.0",
          "urlVerificationScheme": "https://portal.leatherback-cop-sbx.banfico.io/documentation/api-specifications/confirmation-of-payee-v2.0",
          "schemeResponseCodes": ["ANNM"],
          "receivedTime": "2024-09-12T10:28:10.507164Z",
          "data": "ewogICJEYXRhIiA6IHsKICAgICJWZXJpZmljYXRpb25SZXBvcnQiIDogewogICAgICAiTWF0Y2hlZCIgOiB0cnVlCiAgICB9CiAgfSwKICAiTGlua3MiIDogewogICAgIlNlbGYiIDogIi9wYXkudWsvdjIuMC9jb25maXJtYXRpb24tcGF5ZWUvbmFtZS12ZXJpZmljYXRpb24iCiAgfSwKICAiTWV0YSIgOiB7IH0KfQ==",
          "entity": {
            "idType": "PARTICIPANT_ORG_ID",
            "idValue": "N9QOI4uiKOeUp8qa66"
          }
        }
      },
      {
        "reportStatus": "COMPLETE",
        "account": {
          "id": "30000099678911"
        },
        "responder": {
          "accountVerificationScheme": "UK_COP",
          "apiVersion": "2.0.0",
          "urlVerificationScheme": "https://portal.leatherback-cop-sbx.banfico.io/documentation/api-specifications/confirmation-of-payee-v2.0",
          "schemeResponseCodes": ["AC01"],
          "entity": {
            "idType": "PARTICIPANT_ORG_ID",
            "idValue": "N9QOI4uiKOeUp8qa66"
          }
        }
      }
    ]
  }
}

All success responses - 4 checks [MBAM, PANM, ACNS, SCNS]

Request

{
  "data": {
    "query": [
      {
        "xRefId": "f1791b7a-6fb1-4a3d-b6c0-9bf1b03e1234",
        "types": ["NAME"],
        "account": {
          "type": "PERSONAL",
          "idScheme": "SCAN",
          "id": "30000017253489",
          "name": "James Clork"
        }
      },
      {
        "xRefId": "c3e56d49-87f2-4d2b-b73a-61e8b2e32345",
        "types": ["NAME"],
        "account": {
          "type": "BUSINESS",
          "idScheme": "SCAN",
          "id": "30000099678911",
          "name": "Mike Smith"
        }
      },
      {
        "xRefId": "a8e81f7e-5c11-47b7-9981-1b5fb1a83456",
        "types": ["NAME"],
        "account": {
          "type": "PERSONAL",
          "idScheme": "SCAN",
          "id": "30000012345678",
          "name": "John Doe"
        }
      },
      {
        "xRefId": "r7e00w7e-5c11-47b7-9981-1b5fb1a34567",
        "types": ["NAME"],
        "account": {
          "type": "PERSONAL",
          "idScheme": "SCAN",
          "id": "11111111111111",
          "name": "ABC Holdings Limited"
        }
      }
    ]
  }
}

Response

{
  "data": {
    "bulkResult": {
      "id": "8cf682b6-5b09-4c50-94ac-993a6cc79d3a",
      "xRefId": "<string>",
      "message": "Verification has been finished.",
      "status": "COMPLETE"
    },
    "result": [
      {
        "reportStatus": "COMPLETE",
        "account": {
          "id": "30000012345678"
        },
        "responder": {
          "accountVerificationScheme": "UK_COP",
          "apiVersion": "2.0.0",
          "urlVerificationScheme": "https://portal.leatherback-cop-sbx.banfico.io/documentation/api-specifications/confirmation-of-payee-v2.0",
          "schemeResponseCodes": ["MBAM"],
          "entity": {
            "idType": "PARTICIPANT_ORG_ID",
            "idValue": "N9QOI4uiKOeUp8qa66"
          }
        }
      },
      {
        "reportStatus": "COMPLETE",
        "account": {
          "id": "30000017253489"
        },
        "responder": {
          "accountVerificationScheme": "UK_COP",
          "apiVersion": "2.0.0",
          "urlVerificationScheme": "https://portal.leatherback-cop-sbx.banfico.io/documentation/api-specifications/confirmation-of-payee-v2.0",
          "schemeResponseCodes": ["PANM"],
          "entity": {
            "idType": "PARTICIPANT_ORG_ID",
            "idValue": "N9QOI4uiKOeUp8qa66"
          }
        }
      },
      {
        "reportStatus": "COMPLETE",
        "account": {
          "id": "30000099678911"
        },
        "responder": {
          "accountVerificationScheme": "UK_COP",
          "apiVersion": "2.0.0",
          "urlVerificationScheme": "https://portal.leatherback-cop-sbx.banfico.io/documentation/api-specifications/confirmation-of-payee-v2.0",
          "schemeResponseCodes": ["ACNS"],
          "entity": {
            "idType": "PARTICIPANT_ORG_ID",
            "idValue": "N9QOI4uiKOeUp8qa66"
          }
        }
      },
      {
        "reportStatus": "COMPLETE",
        "account": {
          "id": "11111111111111"
        },
        "responder": {
          "accountVerificationScheme": "UK_COP",
          "apiVersion": "2.0.0",
          "urlVerificationScheme": "https://portal.leatherback-cop-sbx.banfico.io/documentation/api-specifications/confirmation-of-payee-v2.0",
          "schemeResponseCodes": ["SCNS"],
          "entity": {
            "idType": "PARTICIPANT_ORG_ID",
            "idValue": "RESP-ORG-ID"
          }
        }
      }
    ]
  }
}

Getting Started

Internal Developer

External Developer