Sign in
Social Securities

Get Social Security

Get a social security record by ID

get/alpha/socialSecurities/{id}

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": {
    "id": "17bbf36498de4d68a0d4f86c7b62f69f",
    "createdAt": "2021-04-14T09:30:24Z",
    "result": {
      "maritalStatus": "Married",
      "currency": "PHP"
    },
    "requestMeta": {
      "mobileNumber": "+639175551234",
      "consent": {
        "type": "Terms and Conditions",
        "version": "1.0.0",
        "consentedAt": "2021-04-14T09:30:24Z",
        "consentedWith": "I agree to the terms and conditions",
        "consentTemplateId": "ct-4604588d9502491b4c72a67cdb0a2aea"
      }
    }
  }
}

Changes