CoP | Developers

Fetch Name Check Result Using Bulk ID

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
502	Bad Gateway
503	Service Unavailable
504	Gateway Timeout

Examples:

Request

bulk-account-verifications-by-ref-id-1a

We need to provide the bulk Id generated using POST API. In the POST API example before, the bulk Id generated is in this case as we have the bulk Id if the user provides “1741005996LMd” in the id field above, the response will be as follows.

Response

Success Response for files with no validation failures

HTTP/1.1 200 Verification has been finished
Content-Type: application/json;charset=utf-8
{
  "data": {
    "bulkResult": {
      "id": "1741005996LMd",
      "message": "Verification has been finished.",
      "status": "COMPLETE"
    },
    "result": [
      {
        "id": "SQJZ1663",
        "reportStatus": "COMPLETE",
        "account": {
          "id": "AT983219568181469228",
          "nameCheckStatus": "FULL_MATCH",
          "identities": [
            {}
          ]
        },
        "responder": {
          "accountVerificationScheme": "EPC_VOP",
          "schemeResponseCodes": [
            {
              "name": "FULL_MATCH",
              "id": []
            }
          ],
          "receivedTime": "2025-03-03T12:46:36.690937Z",
          "data": ""
        }
      },
      {
        "id": "NRGO1664",
        "reportStatus": "COMPLETE",
        "account": {
          "id": "AT723621856794167173",
          "nameCheckStatus": "UNABLE_TO_MATCH",
          "identities": [
            {
              "type": "BOID",
              "value": "989898"
            }
          ]
        },
        "responder": {
          "accountVerificationScheme": "EPC_VOP",
          "schemeResponseCodes": [
            {
              "name": "UNABLE_TO_MATCH",
              "id": []
            }
          ],
          "receivedTime": "2025-03-03T12:46:36.690725Z",
          "data": ""
        }
      }
    ]
  }
}

Failure Responses

Failure Response for files with validation failures

400:

HTTP/1.1 400 Bad Request
Content-Type: application/json; charset=utf-8
Transaction-XRef-Id: 12345678901234567890
{
    "id": "3e6e4d1c-9af9-42cd-8ec9-e2a136a56940",
    "code": "BAD_REQUEST",
    "message": "The request is invalid",
    "errors": [
        {
            "errorCode": "INVALID_FIELD",
            "message": "Invalid IBAN",
            "path": "data.query.account.id",
            "url": "https://{banfico.portal.error.descriptions}"
        },
        {
            "errorCode": "MISSING_FIELD",
            "message": "Must not be null",
            "path": "data.query.account.idScheme",
            "url": "https://{banfico.portal.error.descriptions}"
        }
    ]
}

401:

HTTP/1.1 401 Unauthorized
Content-Type: application/json; charset=utf-8
Transaction-XRef-Id: 12345678901234567890
{
    "id": "3e6e4d1c-9af9-42cd-8ec9-e2a136a56940",
    "code": "UNAUTHORISED",
    "message": "Unauthorized access",
    "errors": [
        {
            "errorCode": "UNAUTHORISED",
            "message": "{Unauthorised reason details}",
            "url": "https://{banfico.portal.error.descriptions}"
        }
    ]
}

403:

HTTP/1.1 403 Forbidden error
Content-Type: application/json; charset=utf-8
Transaction-XRef-Id: 12345678901234567890
{
    "id": "3e6e4d1c-9af9-42cd-8ec9-e2a136a56940",
    "code": "FORBIDDEN",
    "message": "Forbidden resource access",
    "errors": [
        {
            "errorCode": "FORBIDDEN",
            "message": "Forbidden resource access",
            "url": "https://{banfico.portal.error.descriptions}"
        }
    ]
}

404:

HTTP/1.1 404 Not Found
Content-Type: application/json; charset=utf-8
Transaction-XRef-Id: 12345678901234567890
{
    "id": "3e6e4d1c-9af9-42cd-8ec9-e2a136a56940",
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "errors": [
        {
            "errorCode": "NOT_FOUND",
            "message": "{not found resource reason}",
            "url": "https://{banfico.portal.error.descriptions}"
        }
    ]
}

408:

HTTP/1.1 408 Request Timeout
Content-Type: application/json; charset=utf-8
Transaction-XRef-Id: 12345678901234567890
{
  "id": "3e6e4d1c-9af9-42cd-8ec9-e2a136a56940",
  "code": "REQUEST_TIMEOUT",
  "message": "Request timeout",
  "errors": [
    {
      "errorCode": "REQUEST_TIMEOUT",
      "message": "{request timeout resource reason}",
      "url": "https://{banfico.portal.error.descriptions}"
    }
  ]
}

421:

HTTP/1.1 421 Method Not Allowed
Content-Type: application/json; charset=utf-8
Transaction-XRef-Id: 12345678901234567890
{
  "id": "3e6e4d1c-9af9-42cd-8ec9-e2a136a56940",
  "code": "METHOD_NOT_ALLOWED",
  "message": "Method is not allowed",
  "errors": [
    {
      "errorCode": "METHOD_NOT_ALLOWED",
      "message": "This endpoint doesn't currently support the account identification scheme or country where the account is held. Please contact technical support",
      "url": "https://{banfico.portal.error.descriptions}"
    }
  ]
}

429:

HTTP/1.1 429 Too Many Requests
Content-Type: application/json; charset=utf-8
Transaction-XRef-Id: 12345678901234567890
{
  "id": "3e6e4d1c-9af9-42cd-8ec9-e2a136a56940",
  "code": "TOO_MANY_REQUESTS",
  "message": "Too many request received",
  "errors": [
    {
      "errorCode": "TOO_MANY_REQUESTS",
      "message": "The client has sent too many request in short period of time",
      "url": "https://{banfico.portal.error.descriptions}"
    }
  ]
}

500:

HTTP/1.1 500 Unexpected Error
Content-Type: application/json; charset=utf-8
Transaction-XRef-Id: 12345678901234567890
{
  "id": "3e6e4d1c-9af9-42cd-8ec9-e2a136a56940",
  "code": "UNEXPECTED_ERROR",
  "message": "Unexpected error occurred",
  "errors": [
    {
      "errorCode": "UNEXPECTED_ERROR",
      "message": "The operation cannot be complete, an unexpected error occurred",
      "url": "https://{banfico.portal.error.descriptions}"
    }
  ]
}

502:

HTTP/1.1 502 Bad Gateway
Content-Type: application/json; charset=utf-8
Transaction-XRef-Id: 12345678901234567890
{
  "id": "3e6e4d1c-9af9-42cd-8ec9-e2a136a56940",
  "code": "BAD_GATEWAY",
  "message": "Bad Gateway",
  "errors": [
    {
      "errorCode": "BAD_GATEWAY",
      "message": "Bad Gateway",
      "url": "https://{banfico.portal.error.descriptions}"
    }
  ]
}

503:

HTTP/1.1 503 Service currently unavailable
Content-Type: application/json; charset=utf-8
Transaction-XRef-Id: 12345678901234567890
{
  "id": "3e6e4d1c-9af9-42cd-8ec9-e2a136a56940",
  "code": "SERVICE_UNAVAILABLE",
  "message": "Service unavailable",
  "errors": [
    {
      "errorCode": "SERVICE_UNAVAILABLE",
      "message": "VOP Responder system unavailable",
      "url": "https://{banfico.portal.error.descriptions}"
    }
  ]
}

504:

HTTP/1.1 504 VOP Responder time out
Content-Type: application/json; charset=utf-8
Transaction-XRef-Id: 12345678901234567890
{
  "id": "3e6e4d1c-9af9-42cd-8ec9-e2a136a56940",
  "code": "SERVICE_UNAVAILABLE",
  "message": "Service unavailable",
  "errors": [
    {
      "errorCode": "SERVICE_UNAVAILABLE",
      "message": "VOP Responder time out",
      "url": "https://{banfico.portal.error.descriptions}"
    }
  ]
}

Getting Started