---
title: "Check phone number tenure against a threshold"
url: "https://developer.pxg.konera.com/apis/kyc-tenure-1/versions/5ea37c67-a11b-4d51-8c50-95d4237a33c4/operations/checkTenure"
---

> Full API specification: https://developer.pxg.konera.com/apis/kyc-tenure-1/versions/5ea37c67-a11b-4d51-8c50-95d4237a33c4.md

# Check phone number tenure against a threshold

`POST` `/kyc-tenure/v0.1/verify`

Operation ID: `checkTenure`

Checks whether the tenure of a phone number is longer than a provided threshold datetime.

## Header parameters

- `x-correlation-id` (string, optional) - Correlation ID for request tracing

## Request body (required)

Content types: `application/json`

## Responses

- `200` - Tenure check result
- `400` - Bad request
- `401` - Unauthorized
- `403` - Forbidden
- `429` - Too Many Requests
- `500` - Internal server error

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: KYC Tenure
  version: 0.1.0
servers:
  - url: https://api.pxg.konera.com/camara
    description: Production CAMARA API Gateway
paths:
  /kyc-tenure/v0.1/verify:
    post:
      tags:
        - KYC Tenure
      summary: Check phone number tenure against a threshold
      description: Checks whether the tenure of a phone number is longer than a
        provided threshold datetime.
      operationId: checkTenure
      parameters:
        - name: x-correlation-id
          in: header
          required: false
          description: Correlation ID for request tracing
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/TenureRequest"
            example:
              phoneNumber: "+12065550123"
              thresholdDateTime: 2024-01-01T00:00:00Z
      responses:
        "200":
          description: Tenure check result
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TenureResponse"
              example:
                tenureLongerThanThreshold: true
                tenureStartDateTime: 2020-06-15T00:00:00Z
        "400":
          description: Bad request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
        "429":
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
        "500":
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
security:
  - OAuth2ClientCredentials:
      - tenure.read
components:
  schemas:
    TenureRequest:
      type: object
      required:
        - phoneNumber
        - thresholdDateTime
      properties:
        phoneNumber:
          type: string
          description: MSISDN in E.164 format
          example: "+919036499174"
        thresholdDateTime:
          type: string
          format: date-time
          description: The API checks whether the phone number tenure is longer than this
            datetime.
          example: 2024-01-01T00:00:00Z
    TenureResponse:
      type: object
      required:
        - tenureLongerThanThreshold
      properties:
        tenureLongerThanThreshold:
          type: boolean
          description: Indicates whether the number tenure exceeds the threshold
          example: true
        tenureStartDateTime:
          type: string
          format: date-time
          nullable: true
          description: Optional earliest known activation time
    Error:
      type: object
      required:
        - status
        - code
        - message
      properties:
        status:
          type: integer
          example: 400
        code:
          type: string
          example: INVALID_ARGUMENT
        message:
          type: string
          example: Invalid request
  securitySchemes:
    OAuth2ClientCredentials:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://auth.konera.com/oauth2/token
          scopes:
            tenure.read: Read phone number tenure signal
```
