Validating the beneficiary/bank details | Citi Docs Demo

curl -X POST "https://b2b.api.icg.citi.com/citiconnect/prod/addonservices/v1/validations?client_id=6d3cf821-db6d-496d-bec0-064a362e9c31" \
     -H "Idempotency-Id: a44cbb606de4edb9a7a123414bba3bb" \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "method": {
    "method": "ID",
    "type": "TAXID",
    "country": "IN"
  },
  "uetr": "921a9445-97df-4118-9a55-68d14667624c",
  "debtor": {
    "account": "927393890",
    "name": "Hopkin"
  },
  "creditor": {
    "name": "Leo",
    "father_name": "Moss",
    "birth_date": "1950-09-26",
    "document": {
      "type": "TXID",
      "number": "WERHJ9012B"
    }
  }
}'

{
  "uetr": "921a9445-97df-4118-9a55-68d14667624c",
  "method": {
    "method": "ID",
    "type": "TAXID",
    "country": "IN",
    "reasons": {
      "code": 1,
      "description": "EXISTING AND VALID"
    },
    "response": {
      "data_date_time": "2023-09-10T08:23:49.112Z",
      "txid": {
        "date_of_birth_validation": "MATCH",
        "father_name_validation": "MATCH",
        "name_validation": "MATCH",
        "national_id_validation": "MATCH",
        "number_validation": "MATCH",
        "seeding_status": "Y",
        "status": "E"
      },
      "type": "HR"
    }
  },
  "status": {
    "date_time": "2024-09-10T08:23:49.112Z",
    "code": "ACCC",
    "description": "Completed"
  },
  "debtor": {
    "account": "31216787",
    "name": "RAM"
  },
  "creditor": {
    "name": "Leo",
    "father_name": "Moss",
    "birth_date": "1950-09-26",
    "document": {
      "type": "TXID",
      "number": "WERHJ9012B"
    },
    "national_id": 1236
  }
}

This endpoint allows you to validate beneficiary/bank details with the use of combination of parameters

Authentication

AuthorizationBearer

All CitiConnect APIs use the oAuth2 authentication scheme, which requires a bearer token to authenticate your API call. The Token URL includes the version of authentication used by this API. See the Citi Authentication API reference for information on requesting a token.

Headers

Idempotency-IdstringRequired<=128 characters

Your unique identification for a POST request

Maximum length is 128.
CitiConnect API responds with an error (HTTP status 4XX) if your POST request idempotency identification value is a duplicate across a recent history of idempotency identifications in Citi’s database.
If you don’t receive any response (HTTP status 2XX, 4XX or 5XX) from Citi to your POST request and you wish to retry, reinitiate your request with the same idempotency identification to prevent accidental duplicate payment.

Query parameters

client_idstringRequired

Your unique identification, same as the identification you use for OAuth token generation, Citi shared with you during your CitiConnect API onboarding

Request

This endpoint allows you to validate beneficiary/bank details with the use of combination of parameters

methodobjectRequired

uetrstringOptionalformat: "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$"

UUID v4 format unique end-to-end transaction reference

end_to_end_idstringOptional1-35 characters

Client provided reference number.

For Single Euro Payments Area Verification of Payee (SEPA VoP), this parameter is mandatory with max length 35 if method.penny_test = PENNY
For UK bank availability/reachability, this parameter is not applicable
For US Early Warning System (EWS), this parameter is not applicable
For UK, this parameter is not applicable
For IN PAN, this parameter is not applicable
For Global Mastercard Validation this parameter is not applicable

debtorobjectOptional

creditorobjectOptional

Response headers

request_idstringOptional

Citi's unique identification for your request

Response

uetrstringformat: "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$"

UUID v4 format unique end-to-end transaction reference

methodobject

statusobject

end_to_end_idstringOptional1-35 characters

Client provided reference number.

For SEPA VoP, this parameter is optional with max length 35
For UK bank availability/reachability, this parameter is not applicable
For US EWS, this parameter is not applicable
For UK, this parameter is not applicable
For IN PAN, this parameter is not applicable
For Global Mastercard validation, this parameter is not applicable

debtorobjectOptional

creditorobjectOptional

reasonsobjectOptional

responseobjectOptional

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

405

Method Not Allowed Error

409

Conflict Error

415

Unsupported Media Type Error

500

Internal Server Error