api.verify.heyhom.com Open in urlscan Pro
3.12.47.65  Public Scan

Submitted URL: https://api.verify.heyhom.com/
Effective URL: https://api.verify.heyhom.com/redoc
Submission: On August 26 via automatic, source certstream-suspicious — Scanned from DE

Form analysis 0 forms found in the DOM

Text Content

ReDoc requires Javascript to function. Please enable it to browse the
documentation.
 * CURP
   * getObtener Estados
   * getObtener Generos
   * postGenerar Curp
 * IMSS
   * postObtener Nss
   * postSolicitar Semanas Cotizadas
   * postObtener Semanas Cotizadas
 * SAT
   * postGenerar Una Solicitud Nueva
   * postConsultar Facturas
   * postConsultar Resumen
 * postLogin

API docs by Redocly





HEYHOM API (0.0.1)

Download OpenAPI specification:Download




Servcio para la perfilacion de posibles clientes


CURP


OBTENER ESTADOS

Obtiene los estados de la república mexicana que pueden ser usados para generar
la CURP

AUTHORIZATIONS:

OAuth2PasswordBearer


RESPONSES

200

Lsita de los estados de la republica mexicana que se pueden usar en la CURP

get/v1/curp/estados
https://api.verify.heyhom.com/v1/curp/estados


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "states": [
    * "Aguascalientes",
    * "Baja_California",
    * "..."
   
   ]

}


OBTENER GENEROS

Obtiene los géneros que pueden ser usados para generar la CURP

AUTHORIZATIONS:

OAuth2PasswordBearer


RESPONSES

200

Lista de los posibles géneros que se pueden usar en la CURP

get/v1/curp/generos
https://api.verify.heyhom.com/v1/curp/generos


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "genders": [
    * "H",
    * "M",
    * "..."
   
   ]

}


GENERAR CURP

Generea la CURP de una persona dados los siguientes datos:

 * name: Nombre(s) de la persona
 * firstLastName: Apellido paterno de la persona
 * secondLastName: Apellido materno de la persona
 * birthDate: Fecha de nacimiento de la persona en formato DD/MM/YYYY
 * placeOfBirth: Estado de nacimiento de la persona
 * gender: Genero de la persona

AUTHORIZATIONS:

OAuth2PasswordBearer

REQUEST BODY SCHEMA: APPLICATION/JSON



name
string (Name)
Default: "SAMUEL"

firstLastName
string (Firstlastname)
Default: "GUERRERO"

secondLastName
string (Secondlastname)
Default: "ESQUIVEL"

birthDate
string (Birthdate)
Default: "06/09/1927"

placeOfBirth
string (Placeofbirth)
Default: "Distrito_Federal"

gender
string (Gender)
Default: "H"



RESPONSES

200

CURP generada a partir de los datos proporcionados

400

No se pudo generar la CURP

422

Error en el cuerpo de la petición

500

Error interno del servidor

post/v1/curp/generar_curp
https://api.verify.heyhom.com/v1/curp/generar_curp


REQUEST SAMPLES

 * Payload

Content type
application/json
Copy
{
 * "name": "SAMUEL",
 * "firstLastName": "GUERRERO",
 * "secondLastName": "ESQUIVEL",
 * "birthDate": "06/09/1927",
 * "placeOfBirth": "Distrito_Federal",
 * "gender": "H"

}


RESPONSE SAMPLES

 * 200
 * 400
 * 422
 * 500

Content type
application/json
Copy
{
 * "curp": "XXXX000000XXXXXX00"

}





IMSS


OBTENER NSS

Obtiene el NSS de una persona dado su CURP

 * curp: CURP de la persona

AUTHORIZATIONS:

OAuth2PasswordBearer

REQUEST BODY SCHEMA: APPLICATION/JSON



curp
string (Curp)
Default: "GUFR780501MHGTLS07"



RESPONSES

200

Datos obtenidos exitosamente de la persona

400

No se encontraron datos de la persona

422

Error en el cuerpo de la petición

500

Error en la petición

post/v1/imss/obtener_nss
https://api.verify.heyhom.com/v1/imss/obtener_nss


REQUEST SAMPLES

 * Payload

Content type
application/json
Copy
{
 * "curp": "GUFR780501MHGTLS07"

}


RESPONSE SAMPLES

 * 200
 * 400
 * 422
 * 500

Content type
application/json
Copy
{
 * "nss": "13937814245",
 * "name": "ROSARIO BRISA GUTIERREZ FLORES"

}





SOLICITAR SEMANAS COTIZADAS

Solicita las semanas cotizadas de una persona dado su CURP y NSS para consultar
cuando estén listas

 * curp: CURP de la persona
 * nss: NSS de la persona

AUTHORIZATIONS:

OAuth2PasswordBearer

REQUEST BODY SCHEMA: APPLICATION/JSON



curp
string (Curp)
Default: "GULC800401MPLRNN09"

nss
string (Nss)
Default: "02958075901"



RESPONSES

200

La cotización se procesa de manera asyncrona, se obtiene el id de consulta

400

No se logro realizar la cotización

422

Error en el cuerpo de la petición

500

Error interno del servidor

post/v1/imss/solicitar_semanas_cotizadas
https://api.verify.heyhom.com/v1/imss/solicitar_semanas_cotizadas


REQUEST SAMPLES

 * Payload

Content type
application/json
Copy
{
 * "curp": "GULC800401MPLRNN09",
 * "nss": "02958075901"

}


RESPONSE SAMPLES

 * 200
 * 400
 * 422
 * 500

Content type
application/json
Copy
{
 * "idReqQuotedWeeks": "75e1551b-22ae-496c-b0d2-3d7af2a1f441"

}





OBTENER SEMANAS COTIZADAS

Obtiene las semanas cotizadas de una persona dado el identificador de la
solicitud de semanas cotizadas

 * idReqQuotedWeeks: Identificador de la solicitud de semanas cotizadas
 * type: "json" | "pdf"

AUTHORIZATIONS:

OAuth2PasswordBearer

REQUEST BODY SCHEMA: APPLICATION/JSON



idReqQuotedWeeks
string (Idreqquotedweeks)
Default: "6add4770-8d0a-4ff4-915d-9e4e35e4005c"

type
string (Type)
Default: "json"
Enum: "json" "pdf"



RESPONSES

200

Indica la información de las semanas cotizadas de una persona y devuelve los
datos en formato JSON o PDF

400

No se encontro información de la persona ni petición solicitada

422

Error en el cuerpo de la petición

500

Error interno del servidor

post/v1/imss/obtener_semanas_cotizadas
https://api.verify.heyhom.com/v1/imss/obtener_semanas_cotizadas


REQUEST SAMPLES

 * Payload

Content type
application/json
Copy
{
 * "idReqQuotedWeeks": "6add4770-8d0a-4ff4-915d-9e4e35e4005c",
 * "type": "json"

}


RESPONSE SAMPLES

 * 200
 * 400
 * 422
 * 500

Content type
application/jsonapplication/pdfapplication/json
Copy
Expand all Collapse all
{
 * "statusQuotedWeeks": "string",
 * "hasQuotedWeeks": true,
 * "quotedWeeksJson": {
    * "nombre": "string",
    * "curp": "string",
    * "nss": "string",
    * "fechaEmision": "dd/mm/yyyy",
    * "semanasCotizadas": {
       * "semanasCotizadas": "0",
       * "semanasDescontadas": "0",
       * "semanasReintegradas": "0"
      
      },
    * "totalSemanasCotizadas": "0",
    * "historialLaboral": [
       * {
          * "tipoDeMovimiento": "string",
          * "fechaMovimiento": "dd/mm/yyyy",
          * "salarioBase": "0.00"
         
         }
      
      ]
   
   }

}





SAT


GENERAR UNA SOLICITUD NUEVA

Crea una nueva solicitud de consulta de facturas

Requiere:

 * RFC: RFC de la persona
 * password_portal: Contraseña del portal
 * init_date: Fecha de inicio de la consulta
 * end_date: Fecha de fin de la consulta

Respuesta:

 * message: Mensaje de la respuesta
 * uuid: UUID de la solicitud

AUTHORIZATIONS:

OAuth2PasswordBearer

REQUEST BODY SCHEMA: APPLICATION/JSON



RFC
string (Rfc)
Default: "XXXX000000X00"

password_portal
string (Password Portal)
Default: "12345678"

init_date
string (Init Date)
Default: "2024-01-01"

end_date
string (End Date)
Default: "2024-08-25"



RESPONSES

200

Solicitud generada exitosamente

422

Validation Error

post/v1/sat/generar_una_solicitud_nueva
https://api.verify.heyhom.com/v1/sat/generar_una_solicitud_nueva


REQUEST SAMPLES

 * Payload

Content type
application/json
Copy
{
 * "RFC": "XXXX000000X00",
 * "password_portal": "12345678",
 * "init_date": "2024-01-01",
 * "end_date": "2024-08-25"

}


RESPONSE SAMPLES

 * 200
 * 422

Content type
application/json
Copy
{
 * "message": "ok",
 * "uuid": "12345678-1234-1234-1234-123456789012"

}



CONSULTAR FACTURAS

Consulta las facturas obtenidas de una solicitud previamente generada

Requiere:

 * uuid: UUID de la solicitud

Respuesta:

 * message: Mensaje de la respuesta
 * facturas: Lista de facturas

AUTHORIZATIONS:

OAuth2PasswordBearer

REQUEST BODY SCHEMA: APPLICATION/JSON



uuid
string (Uuid)
Default: "12345678-1234-1234-1234-123456789012"



RESPONSES

200

Estado de la solicitud

422

Validation Error

post/v1/sat/consultar_facturas
https://api.verify.heyhom.com/v1/sat/consultar_facturas


REQUEST SAMPLES

 * Payload

Content type
application/json
Copy
{
 * "uuid": "12345678-1234-1234-1234-123456789012"

}


RESPONSE SAMPLES

 * 200
 * 422

Content type
application/json
Copy
Expand all Collapse all
{
 * "message": "ok",
 * "facturas": [
    * {
       * "version": "4.0",
       * "serie": "FD",
       * "folio": "418684",
       * "lugar_de_expedicion": "06050",
       * "fecha": "2024-08-20T11:01:54",
       * "uuid": "08D454D2-D484-4CC4-8BA2-21169B3EE087",
       * "total": 344.13,
       * "subtotal": 296.66,
       * "emisor": {
          * "razon_social": "SELCA ILUMINACION",
          * "RFC": "SIL930127A54",
          * "regimen_fiscal": {
             * "description": "General de Ley Personas Morales",
             * "Company": true,
             * "clave": "601"
            
            }
         
         },
       * "receptor": {
          * "razon_social": "JAUN PEREZ",
          * "RFC": "XXXX000000X00",
          * "domicilio_fiscal": "00000",
          * "regimen_fiscal": {
             * "description": "Régimen Simplificado de Confianza",
             * "Company": true,
             * "Person": true,
             * "clave": "626"
            
            }
         
         },
       * "forma_de_pago": {
          * "description": "Transferencia electrónica de fondos",
          * "clave": "03"
         
         },
       * "metodo_de_pago": {
          * "description": "Pago en una sola exhibición",
          * "clave": "PUE"
         
         },
       * "tipo_de_comprobante": {
          * "clave": "I",
          * "description": "Ingreso"
         
         },
       * "uso_de_cfdi": {
          * "clave": "G03",
          * "description": "Gastos en general."
         
         },
       * "retenidos": [ ],
       * "trasladados": [
          * {
             * "base": 296.66,
             * "tipo_de_factor": "Tasa",
             * "tasa_o_cuota": 0.16,
             * "importe": 47.47,
             * "impuesto": {
                * "clave": "002",
                * "description": "IVA"
               
               }
            
            }
         
         ]
      
      }
   
   ]

}



CONSULTAR RESUMEN

Consulta el resument de facturas obtenidas de una solicitud previamente generada

Requiere:

 * uuid: UUID de la solicitud

Respuesta:

 * message: Mensaje de la respuesta
 * data: Datos de la consulta

AUTHORIZATIONS:

OAuth2PasswordBearer

REQUEST BODY SCHEMA: APPLICATION/JSON



uuid
string (Uuid)
Default: "12345678-1234-1234-1234-123456789012"



RESPONSES

200

Solicitud generada exitosamente

422

Validation Error

post/v1/sat/consultar_resumen
https://api.verify.heyhom.com/v1/sat/consultar_resumen


REQUEST SAMPLES

 * Payload

Content type
application/json
Copy
{
 * "uuid": "12345678-1234-1234-1234-123456789012"

}


RESPONSE SAMPLES

 * 200
 * 422

Content type
application/json
Copy
Expand all Collapse all
{
 * "message": "ok",
 * "data": {
    * "Ingresos": {
       * "subtotal": 0,
       * "IVA": 0,
       * "ISR": 0,
       * "Total": 0
      
      },
    * "Gastos": {
       * "subtotal": 0,
       * "IVA": 0,
       * "ISR": 0,
       * "Total": 0
      
      },
    * "Nomina": {
       * "subtotal": 0,
       * "descuento": 0,
       * "Total": 0
      
      }
   
   }

}



LOGIN

REQUEST BODY SCHEMA: APPLICATION/X-WWW-FORM-URLENCODED



grant_type
Grant Type (string) or Grant Type (null) (Grant Type)

username
required
string (Username)

password
required
string (Password)

scope
string (Scope)
Default: ""

client_id
Client Id (string) or Client Id (null) (Client Id)

client_secret
Client Secret (string) or Client Secret (null) (Client Secret)



RESPONSES

200

Successful Response

422

Validation Error

post/token
https://api.verify.heyhom.com/token


RESPONSE SAMPLES

 * 200
 * 422

Content type
application/json
Copy
null