> ## Documentation Index
> Fetch the complete documentation index at: https://sigma-docs.pastelhq.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Check PEP (Instant)

> ```
POST api/v1/aml/pep/instant
```




## OpenAPI

````yaml aml-model.json POST /aml/pep/instant
openapi: 3.1.0
info:
  title: Sigma API
  description: Sigma AML API documentation
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://sigmaaml.sabipay.com/api/v1
security:
  - ApiKeyAuth: []
    ApiSecretAuth: []
paths:
  /aml/pep/instant:
    post:
      description: Checks if a user is on the pep list and returns result instantly
      requestBody:
        description: Pep request payload
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CheckPepPayload'
            example:
              name: Kwame Asare Mensah
              threshold: 85
              country: GH
      responses:
        '200':
          description: Request was successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckPepInstantResponse'
        '400':
          description: Invalid input or unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    CheckPepPayload:
      type: object
      required:
        - name
        - threshold
      properties:
        name:
          type: string
          description: Full name of the individual to be screened
        threshold:
          type: number
          description: Matching threshold for screening (e.g. similarity score)
          example: 85
        country:
          type: string
          description: Country code (e.g., 'ru' for Russia)
      example:
        name: Kwame Asare Mensah
        threshold: 85
        country: GH
    CheckPepInstantResponse:
      type: object
      properties:
        message:
          type: string
          description: >-
            A message indicating the status of the sanctions list fetch
            operation
        count:
          type: integer
          description: The total number of matching records found
        pageNumber:
          type: integer
          description: The current page number of the results
        data:
          type: array
          description: List of matched individuals/entities from the sanctions or PEP lists
          items:
            type: object
            properties:
              _id:
                type: string
                description: Unique identifier for the matched entity
              type:
                type: string
                description: Type of match (e.g., 'pep', 'sanction')
              externalId:
                type: string
                description: External identifier for the entity, if available
              __v:
                type: integer
                description: Version key used internally
              addresses:
                type: array
                items:
                  type: string
                description: List of known addresses associated with the entity
              aliases:
                type: array
                items:
                  type: string
                description: List of known aliases or alternative names for the entity
              birth_date:
                type: string
                format: date
                description: Date of birth of the entity
              countries:
                type: array
                items:
                  type: string
                description: Countries associated with the entity
              createdAt:
                type: string
                format: date-time
                description: Date when the record was created
              updatedAt:
                type: string
                format: date-time
                description: Date when the record was last updated
              dataset:
                type: array
                description: Sources or datasets where this match was found
                items:
                  type: object
                  properties:
                    name:
                      type: string
                      description: Name of the dataset
                    url:
                      type: string
                      description: URL to the dataset source
              entityType:
                type: string
                description: Type of entity matched (e.g., 'Person', 'Organization')
              name:
                type: string
                description: Full name of the matched entity
              sanctions:
                type: array
                items:
                  type: string
                description: Sanctions associated with the entity, if any
              photo:
                type: string
                description: URL to a photo of the matched entity
              politicalParty:
                type: array
                items:
                  type: string
                description: List of political parties the person is affiliated with
              gender:
                type: string
                description: Gender of the matched entity
              positions:
                type: array
                description: List of positions or roles held by the entity
                items:
                  type: object
                  properties:
                    title:
                      type: string
                      description: Title of the position
                    startDate:
                      type:
                        - string
                        - 'null'
                      description: Start date of the position
                    endDate:
                      type:
                        - string
                        - 'null'
                      description: End date of the position
                    _id:
                      type: string
                      description: Unique identifier for the position
              education:
                type: array
                description: List of educational institutions attended
                items:
                  type: object
                  properties:
                    title:
                      type: string
                      description: Name of the institution
                    startDate:
                      type:
                        - string
                        - 'null'
                      description: Start date of education
                    endDate:
                      type:
                        - string
                        - 'null'
                      description: End date of education
                    _id:
                      type: string
                      description: Unique identifier for the education entry
              tags:
                type: array
                items:
                  type: string
                description: Tags associated with the record
              searchScore:
                type: number
                description: >-
                  Score indicating how closely the entity matches the search
                  criteria
              confidenceScore:
                type: number
                description: Confidence score of the match
      example:
        message: PEP search completed successfully
        count: 1
        pageNumber: 1
        data:
          - _id: 67f95bd9c2a7d1f2b6ea1021
            type: pep
            externalId: PEP-NG-000981
            __v: 0
            addresses:
              - 12 Independence Avenue, Accra, Ghana
            aliases:
              - Kwame Mensah
              - K. A. Mensah
            birth_date: '1972-08-14'
            countries:
              - Ghana
              - United Kingdom
            createdAt: '2026-04-03T09:12:45.000Z'
            updatedAt: '2026-04-03T09:12:45.000Z'
            dataset:
              - name: Global PEP Database
                url: https://datasets.example.com/pep/global-pep-database
            entityType: Person
            name: Kwame Asare Mensah
            sanctions: []
            photo: https://cdn.example.com/pep/kwame-mensah.jpg
            politicalParty:
              - National Reform Party
            gender: male
            positions:
              - title: Minister of Energy
                startDate: '2019-01-10'
                endDate: '2023-02-01'
                _id: 67f95bd9c2a7d1f2b6ea1022
            education:
              - title: University of Ghana
                startDate: '1990-09-01'
                endDate: '1994-06-30'
                _id: 67f95bd9c2a7d1f2b6ea1023
            tags:
              - government-official
              - energy-sector
            searchScore: 96.7
            confidenceScore: 0.93
    Error:
      required:
        - error
        - message
      type: object
      properties:
        error:
          type: integer
          format: int32
        message:
          type: string
      example:
        error: 400
        message: 'Invalid request payload: name is required'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: apiKey
    ApiSecretAuth:
      type: apiKey
      in: header
      name: apiSecret

````