Sign in

v50

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-27107348584.3 KB
Accounts

View Account Payload

View a user's particular account payload.

get/accounts/{id}/payload

Response

OK

code'OK' | 'CREATED' | 'INVALID_CREDENTIALS' | 'INVALID_PARAMETERS' | 'INVALID_TOKEN' | 'UNAUTHORIZED_ACCESS' | 'MISSING_RESOURCE' | 'REQUEST_LIMIT_EXCEEDED' | 'SERVER_ERROR' | 'UNSUPPORTED_METHOD' | 'SERVER_UNAVAILABLE' | 'TIME_LIMIT_EXCEEDED'

Request status code

messagestring

Message response to the request

requestIdstring

Unique ID that is added to the body of every response for easy traceability of the request in our logs.

Example response

{
  "code": "OK",
  "message": "Success",
  "requestId": "5b79399a-6852-4234-bb0e-ad472648282d",
  "data": {
    "metadata": {
      "sourceType": "Account"
    },
    "identity": {
      "id": "17bbf36498de4d68a0d4f86c7b62f69f",
      "fullName": "George Cimafranca Palomero, Jr",
      "firstName": "George",
      "middleName": "Cimafranca",
      "lastName": "Palomero",
      "suffix": "Jr",
      "gender": "Male",
      "maritalStatus": "Married",
      "countryResidence": "PH",
      "photoUrl": "https://cdn.smileapi.io/image/avatar/v20211115191600/george.jpg",
      "referenceId": "~02c0bf6ae6a581ee2b",
      "profileUrl": "https://www.upwork.com/freelancers/~02c0bf6ae6a581ee2b",
      "emails": [
        {
          "address": "gpalomero@yahoo.com",
          "type": "Primary"
        }
      ],
      "phones": [
        {
          "number": "+639175551234",
          "type": "Mobile"
        }
      ],
      "socialProfiles": [
        {
          "socialUrl": "https://www.facebook.com/gpalomero",
          "type": "Facebook"
        }
      ],
      "addresses": [
        {
          "country": "PH",
          "tags": [
            "Primary",
            "Home"
          ]
        }
      ]
    },
    "rating": {
      "id": "17bbf36498de4d68a0d4f86c7b62f69f",
      "currentRating": 90,
      "maxRating": 100,
      "calculatedPercentage": 90,
      "reviewsReceived": 12,
      "likesReceived": 8,
      "jobsCompleted": 12
    },
    "documents": [
      {
        "id": "17bbf36498de4d68a0d4f86c7b62f69f",
        "name": "Facebook Social Media Marketing Professional Certificate",
        "docId": "ABCD123456",
        "status": "VALID",
        "documentType": "IDENTIFICATION",
        "issueDate": "2007-08-24",
        "expiryDate": "2010-08-24",
        "fileUrl": "https://images.credly.com/size/680x680/images/c4a900b7-8d1b-4e8f-a572-347985eeaa5c/Coursera_Badge__1_.png",
        "remarks": "NO RECORD ON FILE"
      }
    ],
    "incomes": [
      {
        "id": "17bbf36498de4d68a0d4f86c7b62f69f",
        "employer": "ABC Corporation",
        "startDate": "2021-06-01",
        "endDate": "2021-06-15",
        "currency": "PHP",
        "frequency": "Annually"
      }
    ],
    "transactions": [
      {
        "id": "17bbf36498de4d68a0d4f86c7b62f69f",
        "date": "2021-04-21",
        "description": "Payment for web design project",
        "currency": "PHP",
        "amount": 10000
      }
    ],
    "employments": [
      {
        "id": "17bbf36498de4d68a0d4f86c7b62f69f",
        "name": "Digital Marketing",
        "description": "Gathering and reporting relevant data, maintaining specific reports and dashboards, using platforms and programs to address marketing requirements, and updating specific marketing materials.",
        "jobTitle": "Digital Marketing Assistant",
        "department": "Marketing",
        "employeeNumber": "EMP-123456",
        "employerNumber": "ER-654321",
        "employer": "ABC Corporation",
        "status": "Permanent",
        "startDate": "2016-02-24",
        "endDate": "2019-08-24",
        "reportedDate": "2019-08-25"
      }
    ],
    "contributions": [
      {
        "id": "17bbf36498de4d68a0d4f86c7b62f69f",
        "date": "2021-04-30",
        "currency": "PHP",
        "amount": 1375,
        "referenceId": "PA9634415"
      }
    ],
    "liabilities": [
      {
        "id": "17bbf36498de4d68a0d4f86c7b62f69f",
        "type": "Salary Loan",
        "amortizationFrequency": "Annually",
        "currency": "PHP"
      }
    ],
    "eincomes": [
      {
        "id": "17bbf36498de4d68a0d4f86c7b62f69f",
        "month": "2021-06",
        "currency": "PHP"
      }
    ],
    "links": [
      {
        "id": "link-123456789012345678901234567890",
        "startDate": "2021-04-14T09:30:24Z",
        "endDate": "2021-04-14T09:30:24Z",
        "records": [
          {
            "linkedAt": [
              "2021-04-14T09:30:24Z"
            ]
          }
        ]
      }
    ],
    "insight": {
      "id": "insight-123456789012345678901234567890",
      "cutoffTime": "2021-04-14T09:30:24Z",
      "features": {
        "incomes_count": 9,
        "incomes_first_income_month_range": -999,
        "incomes_missing_month_max": -999,
        "incomes_missing_month_count": -999,
        "incomes_amount_sum": -999,
        "incomes_amount_average": 1100,
        "incomes_amount_min": 1000,
        "incomes_amount_max": 1200,
        "incomes_amount_median": 1200,
        "incomes_amount_std": 1000,
        "incomes_last3_months_amount_sum": 6000,
        "incomes_last3_months_amount_average": 1100,
        "incomes_last3_months_amount_min": 1000,
        "incomes_last3_months_amount_max": 1200,
        "incomes_last3_months_amount_median": 1200,
        "incomes_last3_months_amount_std": 1000,
        "incomes_last6_months_amount_sum": 6000,
        "incomes_last6_months_amount_average": 1100,
        "incomes_last6_months_amount_min": 1000,
        "incomes_last6_months_amount_max": 1200,
        "incomes_last6_months_amount_median": 1200,
        "incomes_last6_months_amount_std": 1000,
        "incomes_last9_months_amount_sum": 6000,
        "incomes_last9_months_amount_average": 1100,
        "incomes_last9_months_amount_min": 1000,
        "incomes_last9_months_amount_max": 1200,
        "incomes_last9_months_amount_median": 1200,
        "incomes_last9_months_amount_std": 1000,
        "incomes_last12_months_amount_sum": 6000,
        "incomes_last12_months_amount_average": 1100,
        "incomes_last12_months_amount_min": 1000,
        "incomes_last12_months_amount_max": 1200,
        "incomes_last12_months_amount_median": 1200,
        "incomes_last12_months_amount_std": 1000,
        "incomes_last18_months_amount_sum": 6000,
        "incomes_last18_months_amount_average": 1100,
        "incomes_last18_months_amount_min": 1000,
        "incomes_last18_months_amount_max": 1200,
        "incomes_last18_months_amount_median": 1200,
        "incomes_last18_months_amount_std": 1000,
        "incomes_last18_months_max_amount_count": 1000,
        "incomes_starting_amount": 1000,
        "incomes_current_amount": 1000,
        "incomes_latest_growth": 1000,
        "liabilities_loan_count": 1000,
        "liabilities_loan_amount_min": 1000,
        "liabilities_loan_amount_max": 1000,
        "liabilities_loan_amount_total": 1000,
        "liabilities_loan_amount_average": 1000,
        "liabilities_loan_amount_std": 1000,
        "liabilities_finished_loan_count": 1000,
        "liabilities_outstanding_loan_count": 10,
        "liabilities_outstanding_amount_max": 1000,
        "liabilities_outstanding_amount_total": 1000,
        "liabilities_outstanding_amount_average": 1000,
        "liabilities_overdue_loan_count": 10,
        "liabilities_overdue_amount_total": 1000,
        "liabilities_overdue_amount_average": 1000,
        "liabilities_ongoing_amortization_amount_sum": 1000,
        "liabilities_ongoing_amortization_amount_min": 1000,
        "liabilities_ongoing_amortization_amount_max": 1000,
        "liabilities_ongoing_amortization_amount_average": 1000,
        "liabilities_ongoing_amortization_amount_median": 1000,
        "liabilities_ongoing_amortization_amount_std": 1000,
        "liabilities_payment_count": 10,
        "liabilities_payment_amount_max": 1000,
        "liabilities_payment_amount_min": 1000,
        "liabilities_payment_amount_median": 1000,
        "liabilities_payment_amount_average": 1000,
        "liabilities_payment_amount_sum": 1000,
        "liabilities_payment_amount_std": 1000,
        "employments_current_status": "EMPLOYED",
        "employments_employer_count": 3,
        "employments_current_tenure": 5,
        "identity_age": 30,
        "link_days_since_first": 130,
        "link_days_since_last": 2,
        "link_day3_count": 2,
        "link_day7_count": 5,
        "link_day30_count": 8,
        "link_day90_count": 12,
        "link_day180_count": 12,
        "link_day365_count": 12,
        "link_day730_count": 12
      }
    }
  }
}