API Explorer

obp.getCustomers

Get Customers

Format Dec2018 Group Core Suggested order 1

Outbound message (OBP to adapter)
{
  "outboundAdapterCallContext": {
    "correlationId": "1flssoftxq0cr1nssr68u0mioj",
    "outboundAdapterAuthInfo": {
      "userId": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
      "username": "felixsmith",
      "linkedCustomers": [
        {
          "customerId": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
          "customerNumber": "5987953",
          "legalName": "Eveline Tripman"
        }
      ],
      "userAuthContext": [
        {
          "key": "CustomerNumber",
          "value": "5987953"
        }
      ],
      "authViews": [
        {
          "view": {
            "id": "owner",
            "name": "owner",
            "description": "This view is for the owner for the account."
          },
          "account": {
            "id": "8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
            "accountRoutings": [
              {
                "scheme": "IBAN",
                "address": "DE91 1000 0000 0123 4567 89"
              }
            ],
            "customerOwners": [
              {
                "bankId": "gh.29.uk",
                "customerId": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
                "customerNumber": "5987953",
                "legalName": "Eveline Tripman",
                "dateOfBirth": "2018-03-09T00:00:00Z"
              }
            ],
            "userOwners": [
              {
                "userId": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
                "emailAddress": "felixsmith@example.com",
                "name": "felixsmith"
              }
            ]
          }
        }
      ]
    },
    "outboundAdapterConsenterInfo": {
      "userId": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
      "username": "felixsmith",
      "linkedCustomers": [
        {
          "customerId": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
          "customerNumber": "5987953",
          "legalName": "Eveline Tripman"
        }
      ],
      "userAuthContext": [
        {
          "key": "CustomerNumber",
          "value": "5987953"
        }
      ],
      "authViews": [
        {
          "view": {
            "id": "owner",
            "name": "owner",
            "description": "This view is for the owner for the account."
          },
          "account": {
            "id": "8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
            "accountRoutings": [
              {
                "scheme": "IBAN",
                "address": "DE91 1000 0000 0123 4567 89"
              }
            ],
            "customerOwners": [
              {
                "bankId": "gh.29.uk",
                "customerId": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
                "customerNumber": "5987953",
                "legalName": "Eveline Tripman",
                "dateOfBirth": "2018-03-09T00:00:00Z"
              }
            ],
            "userOwners": [
              {
                "userId": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
                "emailAddress": "felixsmith@example.com",
                "name": "felixsmith"
              }
            ]
          }
        }
      ]
    }
  },
  "bankId": {
    "value": "gh.29.uk"
  },
  "limit": 100,
  "offset": 100,
  "fromDate": "1100-01-01T01:01:01.000Z",
  "toDate": "1100-01-01T01:01:01.000Z"
}
Inbound message (adapter to OBP)
{
  "inboundAdapterCallContext": {
    "correlationId": "1flssoftxq0cr1nssr68u0mioj"
  },
  "status": {
    "errorCode": "Status errorCode",
    "backendMessages": [
      {
        "source": "",
        "status": "",
        "errorCode": "",
        "text": "",
        "duration": "5.123"
      }
    ]
  },
  "data": [
    {
      "customerId": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
      "bankId": "gh.29.uk",
      "number": "5987953",
      "legalName": "Eveline Tripman",
      "mobileNumber": "+44 07972 444 876",
      "email": "felixsmith@example.com",
      "faceImage": {
        "date": "2019-09-08T00:00:00Z",
        "url": "http://www.example.com/id-docs/123/image.png"
      },
      "dateOfBirth": "2018-03-09T00:00:00Z",
      "relationshipStatus": "single",
      "dependents": 2,
      "dobOfDependents": [
        "2019-09-08T00:00:00Z",
        "2019-01-03T00:00:00Z"
      ],
      "highestEducationAttained": "Master",
      "employmentStatus": "worker",
      "creditRating": {
        "rating": "",
        "source": ""
      },
      "creditLimit": {
        "currency": "EUR",
        "amount": "1000.00"
      },
      "kycStatus": false,
      "lastOkDate": "2019-09-08T00:00:00Z",
      "title": "title of customer",
      "branchId": "DERBY6",
      "nameSuffix": "Sr",
      "customerType": "INDIVIDUAL",
      "parentCustomerId": ""
    }
  ]
}