API reference · Identity & onboarding

Eligibility

GET/accountholder/{type}/{value}/eligibilityAsk what is true about an account holder without reading what it is based on

GET Ask what is true about an account holder without reading what it is based on

GET /accountholder/{type}/{value}/eligibility

Named questions in, named answers out. A lender asking these reads no birth date, no salary, no address and no licence number. An answer of UNKNOWN means the person never told us; INSUFFICIENT_ASSURANCE means they did and nobody confirmed it. Neither is the same as FALSE, which is a statement about the person.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Path parameters

Name
`type`
`value`

Query parameters

Name	Default
`ageOver`	Optional
`incomeOver`	Optional
`tenureOverMonths`	Optional
`yearsAtAddressOver`	Optional
`licenceBody`	Optional
`vouchCountAtLeast`	Optional
`vouchedResource`	Optional
`attestationLevelAtLeast`	Optional

Example

Response: GenericResponseEligibilityResponse

curl -X GET "https://api.bridgemoni.com/accountholder/value/value/eligibility" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "ageOver": {
      "answer": "TRUE",
      "assuranceGrade": "REG"
    },
    "incomeOver": {
      "answer": "TRUE",
      "assuranceGrade": "REG"
    },
    "tenureOverMonths": {
      "answer": "TRUE",
      "assuranceGrade": "REG"
    },
    "yearsAtAddressOver": {
      "answer": "TRUE",
      "assuranceGrade": "REG"
    },
    "addressVerified": {
      "answer": "TRUE",
      "assuranceGrade": "REG"
    },
    "employmentVerified": {
      "answer": "TRUE",
      "assuranceGrade": "REG"
    },
    "isFormallyEmployed": {
      "answer": "TRUE",
      "assuranceGrade": "REG"
    },
    "hasDegree": {
      "answer": "TRUE",
      "assuranceGrade": "REG"
    },
    "hasSsce": {
      "answer": "TRUE",
      "assuranceGrade": "REG"
    },
    "nyscComplete": {
      "answer": "TRUE",
      "assuranceGrade": "REG"
    },
    "isStudent": {
      "answer": "TRUE",
      "assuranceGrade": "REG"
    },
    "isMarried": {
      "answer": "TRUE",
      "assuranceGrade": "REG"
    },
    "hasDependants": {
      "answer": "TRUE",
      "assuranceGrade": "REG"
    },
    "sanctionsClear": {
      "answer": "TRUE",
      "assuranceGrade": "REG"
    },
    "pepStatus": {
      "answer": "TRUE",
      "assuranceGrade": "REG"
    },
    "licenceActive": {
      "answer": "TRUE",
      "assuranceGrade": "REG"
    },
    "vouchCountAtLeast": {
      "answer": "TRUE",
      "assuranceGrade": "REG"
    },
    "attestationLevelAtLeast": {
      "answer": "TRUE",
      "assuranceGrade": "REG"
    }
  },
  "description": "Eligibility fetched successfully"
}

Responses

Status	When
`200`	Eligibility fetched successfully
`400`	A threshold outside the values this question accepts. Thresholds are bounded because an unbounded one asked repeatedly is a search for the value it was meant to protect

Generated from the OpenAPI document. Branch on the HTTP status: there is no machine-readable error code on the wire. Errors