{"id":5693,"date":"2025-08-05T15:17:54","date_gmt":"2025-08-05T13:17:54","guid":{"rendered":"https:\/\/support.neocheck.com\/?post_type=knowledgebase&p=5693"},"modified":"2025-10-21T15:13:38","modified_gmt":"2025-10-21T13:13:38","slug":"integracion","status":"publish","type":"knowledgebase","link":"https:\/\/support.neocheck.com\/es\/help\/kyb\/v-2-5\/integracion\/","title":{"rendered":"Integraci\u00f3n"},"content":{"rendered":"\n

Lo primero que debemos plantearnos es qu\u00e9 necesidades exactas tiene el proyecto antes de lanzarnos a programar. Por favor echa un vistazo al art\u00edculo \u00abC\u00f3mo integrar NeoCheck<\/a>\u00ab.<\/p>\n\n\n\n

Dicho esto, NeoCheck proporciona una API REST JSON intuitiva y poderosa para integrar verificaciones conformes con KYB (Know Your Business) y AML (Anti Money Laundering) en tu negocio o aplicaci\u00f3n. Esta referencia de API proporciona informaci\u00f3n sobre los endpoints disponibles y c\u00f3mo interactuar con ellos.<\/p>\n\n\n\n

Para especificaciones t\u00e9cnicas detalladas, visita nuestro portal Swagger: https:\/\/kyb.neocheck.net\/Swagger\/index.html<\/a><\/p>\n\n\n\n

Autenticaci\u00f3n API<\/h3>\n\n\n\n

El acceso a la API de NeoCheck est\u00e1 protegido mediante tokens de autorizaci\u00f3n OAuth2. Para autenticar tus solicitudes, debes llamar a la solicitud de autenticaci\u00f3n con un nombre de usuario y una contrase\u00f1a v\u00e1lidos. Estos ser\u00e1n entregados por el equipo de de NeoCheck. El endpoint en cuesti\u00f3n es: \/api\/authorization\/token<\/p>\n\n\n\n

Nota: Los par\u00e1metros apiKey y apiSecret est\u00e1n obsoletos. Simplemente d\u00e9jalos vac\u00edos ya que el contenido se ignora y solo persisten para mantener la compatibilidad con versiones anteriores.<\/strong><\/p>\n\n\n\n

Gesti\u00f3n de Configuraciones<\/h3>\n\n\n\n

Luego de la autenticaci\u00f3n se debe buscar la configuraci\u00f3n con la cual se va a realizar la verificaci\u00f3n. Para esto se pueden utilizar dos endpoints distintos:<\/p>\n\n\n\n

Nota: Para todos los endpoints a partir de este punto, se deben configurar los siguientes par\u00e1metros en el Headers<\/strong>. Authorization<\/strong>, se debe colocar el token obtenido en el request anterior de autenticaci\u00f3n. Ejemplo: Bearer TU_ACCESS_TOKEN. Content-Type<\/strong>, se debe colocar el tipo de contenido correspondiente, application\/json<\/p>\n\n\n\n

    \n
  • \/api\/v1\/kyb\/companies\/lookup<\/code>\n
      \n
    • Este m\u00e9todo Get es utilizado para encontrar las empresas disponibles seg\u00fan los siguientes filtros como query parameters:\n
        \n
      • companyName<\/strong>: El nombre de la configuraci\u00f3n<\/li>\n\n\n\n
      • vatNumber<\/strong>: El CIF de la empresa<\/li>\n\n\n\n
      • country<\/strong>: El pa\u00eds de registro de la empresa<\/li>\n<\/ul>\n<\/li>\n\n\n\n
      • El m\u00e9todo devuelve un listado en forma de array con las compa\u00f1\u00edas con coincidencias<\/li>\n<\/ul>\n<\/li>\n\n\n\n
      • \/api\/v1\/kyb\/companies\/{id}<\/code>\n
          \n
        • Este m\u00e9todo Get es utilizado para obtener la empresa de la verificaci\u00f3n KYB usando el identificador de proveedor como path parameter<\/li>\n\n\n\n
        • Devuelve la empresa de la verificaci\u00f3n KYB correspondiente al identificador pasado como par\u00e1metro<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n\n\n\n

          Gesti\u00f3n de la Verificaci\u00f3n KYB<\/h3>\n\n\n\n

          Al obtener la informaci\u00f3n de la compa\u00f1\u00eda correspondiente, se debe hacer la llamada al endpoint POST \/api\/v1\/kyb\/verifications con el fin de crear la verificaci\u00f3n KYB.<\/p>\n\n\n\n

          En el body<\/strong>, se pueden configurar los siguientes par\u00e1metros:<\/p>\n\n\n\n

            \n
          • companyProviderIdentifier<\/strong>: (String)\n
              \n
            • Descripci\u00f3n: ID de la compa\u00f1\u00eda por parte del proveedor.<\/li>\n\n\n\n
            • Ejemplo: \u00abA12345678\u00bb<\/li>\n<\/ul>\n<\/li>\n\n\n\n
            • manualCompanyData<\/strong>: (Objeto)\n
                \n
              • Descripci\u00f3n: Objeto con los datos de la compa\u00f1\u00eda.<\/li>\n\n\n\n
              • Ejemplo:<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n\n\n\n
                {\n    \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n    \"providerIdentifier\": \"string\",\n    \"businessName\": \"string\",\n    \"businessRegNumber\": \"string\",\n    \"vatNumber\": \"string\",\n    \"dateOfRegistration\": \"2025-08-06T13:14:06.612Z\",\n    \"address\": {\n      \"addressLine1\": \"string\",\n      \"addressLine2\": \"string\",\n      \"postalCode\": \"string\",\n      \"locality\": \"string\",\n      \"province\": \"string\",\n      \"country\": \"string\",\n      \"currentAddress\": true\n    }<\/code><\/pre>\n\n\n\n
                  \n
                • kybVerificationId<\/strong>: (Guid)\n
                    \n
                  • Descripci\u00f3n: ID de la verificaci\u00f3n KYB.<\/li>\n\n\n\n
                  • Ejemplo: \u00ab00000000-0000-0000-0000-000000000000<\/code>\u00bb<\/li>\n<\/ul>\n<\/li>\n\n\n\n
                  • applicantId<\/strong>: (Guid)\n
                      \n
                    • Descripci\u00f3n: ID del aplicante.<\/li>\n\n\n\n
                    • Ejemplo: \u00ab00000000-0000-0000-0000-000000000000<\/code>\u00bb<\/li>\n<\/ul>\n<\/li>\n\n\n\n
                    • notificationApiUrl<\/strong>: (String)\n
                        \n
                      • Descripci\u00f3n: URL a la que se enviar\u00e1n las notificaciones de estado de la verificaci\u00f3n.<\/li>\n\n\n\n
                      • Ejemplo: \u00abhttps:\/\/example.com\/api\/notifications\u00bb<\/li>\n<\/ul>\n<\/li>\n\n\n\n
                      • kybVerificationTicket<\/strong>: (Objeto)\n
                          \n
                        • Descripci\u00f3n: Objeto en el cual se a\u00f1aden los datos del ticket y del aplicante, como nombre, direcci\u00f3n de correo, n\u00famero de tel\u00e9fono, lenguaje y si se enviar\u00e1 el link directamente al aplicante por correo.<\/li>\n\n\n\n
                        • Ejemplo: <\/li>\n<\/ul>\n<\/li>\n<\/ul>\n\n\n\n
                          {\n    \"name\": \"string\",\n    \"emailAddress\": \"string\",\n    \"phoneNumber\": \"string\",\n    \"language\": \"string\",\n    \"sendLink\": true\n  }<\/code><\/pre>\n\n\n\n
                          Ejemplo completo del body<\/h4>\n\n\n\n
                          {\n  \"companyProviderIdentifier\": \"string\",\n  \"manualCompanyData\": {\n    \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n    \"providerIdentifier\": \"string\",\n    \"businessName\": \"string\",\n    \"businessRegNumber\": \"string\",\n    \"vatNumber\": \"string\",\n    \"dateOfRegistration\": \"2025-08-06T13:14:06.612Z\",\n    \"address\": {\n      \"addressLine1\": \"string\",\n      \"addressLine2\": \"string\",\n      \"postalCode\": \"string\",\n      \"locality\": \"string\",\n      \"province\": \"string\",\n      \"country\": \"string\",\n      \"currentAddress\": true\n    },\n    \"kybVerificationId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n  },\n  \"applicantId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"notificationApiUrl\": \"string\",\n  \"kybVerificationTicket\": {\n    \"name\": \"string\",\n    \"emailAddress\": \"string\",\n    \"phoneNumber\": \"string\",\n    \"language\": \"string\",\n    \"sendLink\": true\n  }\n}<\/code><\/pre>\n\n\n\n
                          Este endpoint nos dar\u00e1 como respuesta un string, el cual corresponde como el ID de la verificaci\u00f3n.<\/p>\n\n\n\n
                          Obtener el link manualmente<\/h3>\n\n\n\n
                          En caso de que el link del ticket, se quiera obtener de forma manual, se puede hacer una llamada al siguiente endpoint: \/api\/v1\/kyb\/verifications\/{id}\/ticket\/link. En el cual el id es el ID de la verificaci\u00f3n obtenido en el paso anterior. <\/p>\n\n\n\n
                          Devolver\u00e1 un string correspondiente al url del ticket para el aplicante.<\/p>\n\n\n\n
                          Manejo de errores<\/h4>\n\n\n\n
                          La API de Neocheck devuelve c\u00f3digos de estado HTTP est\u00e1ndar para indicar el \u00e9xito o el fallo de una solicitud. Aqu\u00ed algunos ejemplos comunes:<\/p>\n\n\n\n
                            \n
                          • 200 OK<\/strong>: La solicitud fue exitosa.<\/li>\n\n\n\n
                          • 401 Unauthorized<\/strong>: La autenticaci\u00f3n fall\u00f3 o la clave de API es inv\u00e1lida. Se debe revisar el token que se esta colocando para la request.<\/li>\n\n\n\n
                          • 404 Not Found<\/strong>: El recurso solicitado no se encontr\u00f3. Se debe revisar el endpoint al cual se esta apuntando.<\/li>\n\n\n\n
                          • 500 Internal Server Error<\/strong>: fallo interno del sistema.<\/li>\n<\/ul>\n","protected":false},"excerpt":{"rendered":"
                            Lo primero que debemos plantearnos es qu\u00e9 necesidades exactas tiene el proyecto antes de lanzarnos a programar. Por favor echa un vistazo al art\u00edculo \u00abC\u00f3mo integrar NeoCheck\u00ab. Dicho esto, NeoCheck proporciona una API REST JSON intuitiva y poderosa para integrar verificaciones conformes con KYB (Know Your Business) y AML (Anti Money Laundering) en tu negocio  […]<\/p>\n","protected":false},"author":51,"featured_media":0,"comment_status":"open","ping_status":"open","template":"","knowledgebase_cat":[397],"class_list":["post-5693","knowledgebase","type-knowledgebase","status-publish","hentry","knowledgebase_cat-v-2-5"],"_links":{"self":[{"href":"https:\/\/support.neocheck.com\/es\/wp-json\/wp\/v2\/knowledgebase\/5693","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/support.neocheck.com\/es\/wp-json\/wp\/v2\/knowledgebase"}],"about":[{"href":"https:\/\/support.neocheck.com\/es\/wp-json\/wp\/v2\/types\/knowledgebase"}],"author":[{"embeddable":true,"href":"https:\/\/support.neocheck.com\/es\/wp-json\/wp\/v2\/users\/51"}],"replies":[{"embeddable":true,"href":"https:\/\/support.neocheck.com\/es\/wp-json\/wp\/v2\/comments?post=5693"}],"version-history":[{"count":0,"href":"https:\/\/support.neocheck.com\/es\/wp-json\/wp\/v2\/knowledgebase\/5693\/revisions"}],"wp:attachment":[{"href":"https:\/\/support.neocheck.com\/es\/wp-json\/wp\/v2\/media?parent=5693"}],"wp:term":[{"taxonomy":"knowledgebase_cat","embeddable":true,"href":"https:\/\/support.neocheck.com\/es\/wp-json\/wp\/v2\/knowledgebase_cat?post=5693"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}