CS - OFAC Web Service - Manual Técnico

Página 1 de 14 Manual Técnico BW Web Service OFAC

Manual para Integración de BW OFAC Web Service

El siguiente manual contiene información técnica sobre el funcionamiento y la

utilización de BW Web Service OFAC

Elaborado por: Santiago Anda

Cargo: Asistente de Tecnología

Fecha de Elaboración: 19 de Diciembre de 2008

Fecha Última Actualización: 11 de noviembre de 2010

Responsable de Actualización: Erik Mafla N.


TABLA DE CONTENIDO

1 INTRODUCCIÓN ____________________________________________________________________ 3

2 PLATAFORMA ______________________________________________________________________ 3

3 ESTRUCTURA DE BW WEB SERVICE OFAC ___________________________________________ 3

4 MÉTODOS PÚBLICOS DE BW WEB SERVICE OFAC ____________________________________ 4

4.1 BUSQUEDAIDVERIFICATION ___________________________________________________________ 4 4.2 BUSQUEDACHECKNAMES _____________________________________________________________ 6 4.3 BUSQUEDACHECKWIRE ______________________________________________________________ 7 4.4 BUSQUEDAALTERNATESEARCH ________________________________________________________ 8 4.5 BUSQUEDAINTELIGENTEOFAC ________________________________________________________ 9

5 ESTRUCTURA DEL DATASET PARA RESULTADOS DE BÚSQUEDAS __________________ 11

6 CÓDIGOS DE ERROR _______________________________________________________________ 12

7 RECOMENDACIONES ______________________________________________________________ 13

7.1 ERROR 2061 EN BÚSQUEDA BATCH ____________________________________________________ 13 7.2 ERROR 1999 EN BUSQUEDA BATCH ____________________________________________________ 14


1 INTRODUCCIÓN

El servicio web denominado BW OFAC Web Service es un componente de avanzada tecnología que forma parte del sistema Risk Control Service y se ha desarrollado con el objeto de permitir la automatización de los procesos de búsquedas OFAC integrando a otros sistemas. BW OFAC Web Service cuenta con los algoritmos de búsquedas más eficientes, los cuales además son producto de investigaciones y análisis de empresas y organismos especializados en el tema de Cumplimiento y Control de Lavado de Activos a nivel mundial. BW OFAC Web Service utiliza el sistema Bridger Insight y su Developer Kit por lo que además está en capacidad de hacer las búsquedas frente a todas las listas de impedidos provistas por ChoicePoint. Cabe recalcar que dichas listas son emitidas y certificadas por el Federal Reserve de los Estados Unidos de Norteamérica. Adicionalmente, BW OFAC Web Service permite realizar búsquedas contra listas de denegados propias de su Institución, las cuales previamente debieron haber sido cargadas en Risk Control Service. BW OFAC Web Service básicamente es un servicio web donde se encuentran métodos de búsqueda provistos por Bridger Insight. A este web service podrá conectarse cualquier aplicación para utilizar los métodos de búsqueda publicados. A continuación se encuentra el manual técnico de la aplicación BW OFAC Web Service en donde se describen sus métodos públicos, su estructura, parámetros y la forma para utilizarlos.

2 PLATAFORMA

BW OFAC Web Service se encuentra desarrollado en Microsoft Visual Studio 2008 utilizando como lenguaje de programación C#. Su plataforma de operación para el servidor es: Sistema operativo: Microsoft Windows 2000 Pro, 2000 Server, XP Pro ó 2003 Server. Requiere Microsoft Internet Information Server. Requiere Microsoft Framework 3.5. Bridger Insight y Bridger Developer Kit 6.0.0 ó superior. BW OFAC Web Service utiliza el objeto COM de Bridger Developer Kit. Funciona como un componente COM y como un servicio web. Puede ser utilizado por cualquier aplicación web y por sistemas desarrollados en lenguajes de última generación como C# de Microsoft Visual Studio 2008, 2005, 2003, Visual Basic 2005, Java, etc. Para su instalación y funcionamiento requiere de Internet Information Server.

3 ESTRUCTURA DE BW WEB SERVICE OFAC

A continuación se esquematiza la estructura funcional de los componentes de Risk Control Service y la automatización frente a cualquier sistema externo: RCS ó cualquier sistema externo se comunican con el web service BW Web Service OFAC el cual utiliza

la librería COM de Bridger Insight denominada Developer Kit.


Tanto RCS como el sistema externo envían peticiones de búsqueda al BW Web Service OFAC el cual

devuelve los resultados de estas peticiones.

4 MÉTODOS PÚBLICOS DE BW WEB SERVICE OFAC

La clase BW_ServicioOFAC contiene los métodos públicos que el servicio web pone a disposición a sus Clientes. A continuación se describen los parámetros y funcionamiento de éstos métodos. Nota importante: la columna Opcional indica que dicho parámetro no se requiere como obligatorio, sin embargo, es necesario contemplarlo al momento de utilizar el método. Para ciertos tipos de datos como numéricos, los cuales no pueden estar vacíos por definición, se especifica el valor por defecto. Para otros tipos de datos como string, es posible pasar un dato vacío.

4.1 BusquedaIDVerification

Formato del Método: public ResultadosRevisionOFAC BusquedaIDVerification (string licenciaEmpresa, string tipoOrganizacion, string firstName, string middleName, string lastName, int tipoIdentificación, string identificacion, string direccion, string ciudad, string estado, string codigoPostal, string pais, string fechaNacimiento, string generacion, string telfCasa, string telfTrabajo,string issuingCountry, string expDate, string idPolitica, string userName, string perfilUsuario,string valoresDefault, string rutaSetupDB, string rutaReportes, string rutaLog, string nombreLog, int proveedorIDV, string pathProveedorIDV, int identityVerificationSetupOption, string metodoBusqueda, ref string primaryKey, ref int codError, ref string descripcionError) Descripción: Método que realiza una búsqueda de nombre con identificacioón. Se debe tomar en cuenta que para utilizar este tipo de búsqueda se requiere como mínimo el nombre, el apellido y la identificación.

Realiza la Petición

Devuelve Resultados

BW WEB SERVICE OFAC

SISTEMA EXTERNO

Realiza la Petición

Devuelve Resultados

RISK CONTROL SERVICE

BW WEB SERVICE OFAC

BW WEB SERVICE OFAC

RISK CONTROL SERVICE

SISTEMA EXTERNO BRIDGER DEVELOPER KIT

OBJETO COM


Parámetros:

Parámetro Descripción Opcional I/O

licenciaEmpresa Contiene la licencia otorgada por ComplianceServ X I

tipoOrganizacion Contiene el tipo de persona sobre la cual se quiere hacer la búsqueda. Acepta los siguientes valores: “I” para Individual lo que corresponde a personas naturales, y “O” para Organizaciones como nombres de empresas

X I

firstName Contiene el primer nombre de la persona natural o jurídica X I

middleName Contiene el segundo nombre de la persona natural I

lastName Contiene el apellido de la persona natural o jurídica X I

tipoIdentificacion Contiene el tipo de identificación de la persona natural o jurídica. Este parámetro es un entero que puede ser: “1”: Cédula “2”: Otro “3”: Pasaporte “4”: SSN/EIN “5”: Visa

X I

identificacion Contiene la identificación de la persona natural o jurídica X I

direccion Contiene la dirección de la persona natural o jurídica I

ciudad Contiene la ciudad asociada a la persona natural o jurídica I

estado Contiene el estado o provincia asociado a la persona natural o jurídica

I

codigoPostal Contiene el código postal de la persona natural o jurídica I

pais Contiene el país asociado a la persona natural o jurídica I

fechaNacimiento Contiene la fecha de nacimiento de le la persona natural I

generacion Contiene el género de la persona natural.(Jr. II, III) I

telfCasa Contiene el teléfono del domicilio de la persona natural I

telfTrabajo Contiene el teléfono del trabajo de la persona natural o jurídica I

issuingCountry Contiene el país donde se obtuvo el documento de identificación de la persona natural o jurídica

I

expDate Contiene la fecha de expiración del documento de identificación de la persona natural o jurídica

I

idPolítica Contiene el identificador de la política de búsqueda que se debe aplicar. El sistema automátricamente obtendrá los datos de esta política con la cual realizará la búsqueda. Esta política debe haber sido creada previamente en RCS.

X I

userName Contiene el nombre del usuario que realiza la búsqueda X I

perfilUsuario Contiene el perfil o departamento del usuario que realiza la búsqueda

X I

valoresDefault Este parámetro indica si se debe utilizar por defecto alguna configuración definida anteriormente, o si se deben aplicar los datos que se encuentran en los parámetros de color gris. Permite los siguientes valores: Vacío o cualquier otro valor no especificado: denota que se

deben aplicar los valores que se encuentran en los parámetros resaltados en color gris.

RCS: se debe aplicar la configuración por defecto de RCS.

I

rutaSetupDB Contiene la ruta donde se encuentra el archivo Setup.db. La ruta por defecto es: C:\Bridger\COM\

X I

rutaReportes Parámetro que setea la ruta donde están los reportes. La ruta X I


por defecto es: C:\Bridger\COM\

rutaLog Contiene la ruta del Log X I

nombreLog Contiene el nombre del Log X I

proveedorIDV Contiene el proveedor con el cual se va a realizar la búsqueda. El valor permitido es 4.

0 I

pathProveedorIDV Contiene la ruta de los proveedores. El valor por defecto es: C:\Bridger\BridgerDataFiles\

X I

identityVerification SetupOption

Parámetro de seguridad y confirmación para determinar como realizar un IDV Check. Actualmente no se utiliza este parámetro.

0 I

metodoBusqueda Contiene el método de la búsqueda. Se debe enviar como parámetro la palabra AUTO o simplemente se puede enviar una cadena vacía.

I

primaryKey Parámetro por referencia que devuelve un primary key con el que se grabó la búsqueda en la base de datos de RCS.

O

codError Parámetro por referencia que devuelve el código de error del método. Retorna 0 (cero) si todo se ha procesado correctamente ó un valor diferente en caso de que exista error

0 O

descripcionError Parámetro por referencia que devuelve la descripción del codError

O

Retorno: Retorna un dataset del tipo ResultadosRevisionOFAC con los resultados de la búsqueda en caso de que todo se haya procesado correctamente.

4.2 BusquedaCheckNames

Formato del Método: public ResultadosRevisionOFAC BusquedaCheckNames (string licenciaEmpresa, string nombreABuscar, string direccion, string ciudad, string estado, string codigoPostal, string pais, string idPolitica, string userName, string perfilUsuario, string valoresDefault, string rutaSetupDB, string rutaReportes, string rutaLog, string nombreLog, string metodoBusqueda, ref string primaryKey, ref int codError, ref string descripcionError) Descripción: Método que realiza la búsqueda de nombre. Para utilizar este tipo de búsqueda se requiere el nombre a buscar como mínimo. Parámetros:



nombreABuscar Contiene el nombre a buscar en el cual se pueden incluyen los nombres y apellidos en caso de personas naturales, o las palabras que conforman el nombre de una persona jurídica

X I




I



idPolítica Contiene el identificador de la política de búsqueda que se debe aplicar. El sistema automátricamente obtendrá los datos de esta

X I


política con la cual realizará la búsqueda. Esta política debe haber sido creada previamente en RCS.


perfilUsuario Contiene el perfil o departametno del usuario que realiza la búsqueda

X I

valoresDefault Este parámetro indica si se debe utilizar alguna configuración definida anteriormente por defecto, o si se deben aplicar los datos que se encuentran en los parámetros de color gris. Permite los siguientes valores: Vacío o cualquier otro valor no especificado: denota que se


RCS: se debe aplicar la configuración por defecto de RCS.

I


X I

rutaReportes Parámetro que setea la ruta donde están los reportes. La ruta por defecto es: C:\Bridger\COM\

X I




I


O


0 O


O


4.3 BusquedaCheckWire

Formato del Método: public ResultadosRevisionOFAC BusquedaCheckWire (string licenciaEmpresa, string nombreABuscar, string nombreArchivo, string idPolitica, string userName, string perfilUsuario, string valoresDefault, string rutaSetupDB, string rutaReportes, string rutaLog, string nombreLog, string metodoBusqueda, ref string primaryKey, ref int codError, ref string descripcionError) Descripción: Método que realiza la búsqueda sobre un texto el cual se incluya como un parámetro o se recupere desde un archivo plano. Parámetros:



nombreABuscar Contiene el texto sobre el cual se realizará la búsqueda. Permite una longitud máxima de 5,125 caracteres

X I


nombreArchivo Campo no utilizado actualmente I


X I



X I



RCS: se debe aplicar la configuración por defecto para RCS.

I


X I


X I




I


O


0 O


O


4.4 BusquedaAlternateSearch

Formato del Método: public ResultadosRevisionOFAC BusquedaAlternateSearch (string licenciaEmpresa, string nombreABuscar, string idPolitica, string userName, string perfilUsuario, string valoresDefault, string rutaSetupDB, string rutaReportes, string rutaLog, string nombreLog, string metodoBusqueda, ref string primaryKey, ref int codError, ref string descripcionError) Descripción: Método que realiza una búsqueda exacta, es decir, el porcentaje de aproximación será el 100%. Se debe especificar el dato a buscar.


Parámetros:



nombreABuscar Contiene el dato a buscar. Si bien este tipo de búsqueda se utiliza para encontrar datos exactos como números de cédulas, pasaportes, números de cuentas bancarias, etc., es posible incluir varias palabras en este parámetro

X I


X I



X I




I


X I


X I




I


O


0 O


O


4.5 BusquedaInteligenteOFAC

Formato del Método: public ResultadosRevisionOFAC BusquedaInteligenteOFAC(string licenciaEmpresa, string firstName, string middleName, string lastName, int tipoIdentificacion, string identificacion, string direccion, string ciudad, string estado, string codigoPostal, string pais, string fechaNacimiento, string generacion, string telfCasa, string telfTrabajo, string issuingCountry, string expDate, string idPolitica, string userName, string perfilUsuario, string valoresDefault, string rutaSetupDB, string rutaReportes, string rutaLog, string nombreLog, int proveedorIDV,


string pathProveedorIDV, int identityVerificationSetupOption, ref string tipoBusquedaUsada, string metodoBusqueda, ref string primaryKey, ref int codError, ref string descripcionError) Descripción: Método que realiza búsquedas de acuerdo a los parámetros enviados, es decir, decide cuál método de los disponibles utiliza para realizar una búsqueda de acuerdo a los parámetros que recibe. Al menos se debe enviar un parámetro que sea el nombre o documento de identificación. Parámetros:



firstName Contiene el primer nombre de la persona natural o nombre completo de la persona jurídica

X I

middleName Contiene el segundo nombre de la persona natural I

lastName Contiene el apellido de la persona natural I

tipoIdentificacion Contiene el tipo de identificación de la persona natural o jurídica. Este parámetro es un entero que puede ser: “1”: Cédula “2”: Otro “3”: Pasaporte “4”: SSN/EIN “5”: Visa

X I

identificacion Contiene la identificación de la persona natural o jurídica X I




I



fechaNacimiento Contiene la fecha de nacimiento de le la persona natural I

generacion Contiene el género de la persona natural.(Jr. II, III) I

telfCasa Contiene el teléfono del domicilio de la persona natural I

telfTrabajo Contiene el teléfono del trabajo de la persona natural o jurídica I

issuingCountry Contiene el país donde se obtuvo el documento de identificación de la persona natural o jurídica

I

expDate Contiene la fecha de expiración del documento de identificación de la persona natural o jurídica

I


X I



X I



I




X I


X I



proveedorIDV Contiene el proveedor con el cual se va a realizar la búsqueda. El valor permitido es 4.

0 I

pathProveedorIDV Contiene la ruta de los proveedores. El valor por defecto es: C:\Bridger\BridgerDataFiles\

X I

identityVerification SetupOption

Parámetro de seguridad y confirmación para determinar como realizar un IDV Check. Actualmente no se utiliza este parámetro.

0 I

tipoBusquedaUsada Parámetro por referencia en el que se devuelve el tipo de búsqueda utilizada. Los tipos de búsqueda son los soportados por BW Web Service OFAC y descritos anteriormente

O


I

primaryKey Parámetro por referencia que devuelve un primary key con el que se grabó la búsqueda en la base de datos de RCS

O


0 O


O


5 ESTRUCTURA DEL DATASET PARA RESULTADOS DE BÚSQUEDAS

Para devolver los resultados de las búsquedas realizadas en RCS mediante el servicio BW Web Service OFAC, con cualquiera de los métodos provistos por este, se utiliza un objeto DATASET que tiene una estructura que se describe a continuación, la cual debe ser procesada por los sistemas que utilizan el servicio BW Web Service OFAC. Esta estructura se conoce con el nombre ResultadosRevisionOFAC y se presenta a continuación:

Campo Tipo de Dato Descripción

Score String Porcentaje de la coincidencia

File String Ruta y nombre del archivo de la lista con la que se presentó la coincidencia

Filedate String Fecha de actualización del archivo de la lista con la que se presentó la coincidencia

WireContext String Contexto Wire resultante de una búsqueda tipo Check Wire conteniendo las palabras con las que se presentó la coincidencia

EntityName String Nombre de la entidad de la búsqueda resultante

BestName String Nombre más aproximado de la conincidencia


DenyReason String Razón de denegación asignada a la lista en la que se presentó la coincidencia

Listing String Detalles adicionales de la coincidencia

Un ejemplo práctico de cómo se observa este DATASET con información es el siguiente:

Score File FileDate WireContext

EntityName BestName DenyReason Listing

100 DFAT.BDF

06/18/2007

BIN LADEN USAMA MUHAMMED AWAD

OSAMA BIN LADEN

Bin Laden, Usama Muhammed Awad - Individual

100 EUTL.BDF

06/17/2005

USAMA BIN LADEN

OSAMA BIN LADEN

EU Consolidated List

Bin Laden, Usama Muhammed Awad - Individual

6 CÓDIGOS DE ERROR

Existen diferentes tipos de errores que se pueden presentar cuando se utiliza el servicio BW Web Service OFAC, sin embargo, es posible dividirlos en dos grandes grupos: Errores controlados.- aquellos que se presentan por factores internos o por datos errados que no cumplen

con las especificaciones de BW Web Service OFAC. Sin embargo, en cualquier caso, se trata de errores que se encuentran bajo total control del sistema y/o que pueden ser reconocidos por el mismo.

Excepciones externas.- errores que se presentan en componentes externos como el sistema operativo, las base de datos, disco duro, sistema de archivos del servidor, seguridades o cualquier otro de similares características. Sin embargo, es importante aclarar que estos errores no producirán la caída del sistema o la suspensión del servicio, sino que requerirán de la intervención de un técnico de Sistemas. Para el caso de las excepciones externas, los métodos de BW Web Service OFAC añadirán a sus propios códigos de retorno y descripciones, toda la información devuelta por los sistemas externos en referencia al error devuelto.

A continuación se detallan los códigos de los errores controlados por BW Web Service OFAC:

Código Descripción

1900 – 2000 Aplicación Web

1900 Tipo de parámetro ingresado incorrecto

1901 Cantidad de parámetros ingresados no corresponden al método

2000 – 2049 Métodos de Búsqueda

2000 Error en método público al intentar realizar BusquedaIDVerification

2001 Error en método BW_IdVerification al intentar realizar CargarProveedorIDV

2002 Error en método BW_IdVerification al intentar realizar ConfiguracionIDV

2003 Error en método BW_IdVerification al intentar realizar LimpiarVariablesdeBusquedaIDV

2004 Error en método BW_IdVerification al intentar realizar ConfiguracionIndividual

2005 Error en método BW_IdVerification al intentar realizar ConfiguracionOrganizacion

2006 Error en método BW_IdVerification al intentar realizar Buscar


2007 Error en método BW_IdVerification al intentar realizar ValidarParametrosIDVerification

2008 Error en método BW_IdVerification al intentar realizar ValidarParametrosIDVerificationIndividual

2009 Error en método BW_IdVerification al intentar realizar ValidarParametrosIDVerificationOrganization

2010 Error en método público al intentar realizar BusquedaCheckNames

2011 Error en método BW_CheckNames al intentar realizar Buscar

2012 Error en método BW_CheckNames al intentar realizarValidarParametrosCheckNames

2020 Error en método público al intentar realizar BusquedaCheckWire

2021 Error en método BW_CheckWire al intentar realizar Buscar

2022 Error en método BW_CheckWire al intentar realizar ValidarParametrosCheckWire

2030 Error en método público al intentar realizar BusquedaAlternateSearch

2031 Error en método BW_AlternateSearch al intentar realizar Buscar

2032 Error en método BW_AlternateSearch al intentar realizar ValidarParametrosAlternateSearch

2040 Error en método público al intentar realizar BusquedaInteligenteOFAC

2050 – 2069 Developer kit

2050 Error al intentar realizar ValidarAccesso

2051 No se puede Hallar la Ruta de Setup.db

2052 La Licencia es inválida

2053 Error al intentar realizar ConfiguracionOpcionesBusqueda

2054 Error en SetPath

2055 Error en SetReportsPath

2056 Error al intentar realizar ConfiguracionScoreBaseParaTodasLasListas

2057 No se pudo agregar archivos

2058 No se pudo Setear el Porcentaje mínimo

2059 Error al intentar realizar AsignarOpcionesBusqueda

2060 Error al intentar realizar ConfiguracionScoreBasePorLista

2061 Intento de leer o escribir en la memoria protegida. A menudo, esto indica que hay otra memoria corrupta

2070 – 2079 Log

2070 Error en método BW_Log al intentar realizar CrearArchivoLog

2071 Error en método BW_Log al intentar realizar InsertarRegistro

2072 Error en método BW_Log al intentar realizar BorrarArchivoLog

7 RECOMENDACIONES

7.1 Error 2061 en Búsqueda Batch

Cuando se consume el Web Service de OFAC (RCS WS OFAC) desde un sistema externo para hacer una búsqueda batch, al intenta realizar varias búsquedas en un mismo segundo aparece el error 2061 que se muestra a continuación: Attempted to read or write protected memory. This is often an indication that other memory is corrupt. Solución


En la aplicación externa se debe evaluar el código de error retornado por el método del Web Service de OFAC (RCS WS OFAC) y, en caso de que se presente el error 2061 se debe liberar la memoria del objeto utilizado para ejecutar dicha búsqueda y ejecutar nuevamente la llamada al método que realiza la búsqueda.

7.2 Error 1999 en Busqueda Batch

Este error se presentó en la Corporación Financiera Nacional cuando desde el sistema Cobis se realizaba una búsqueda tipo batch, es decir, búsquedas individuales para muchos registros. A continuación la pantalla del error:

Solución: Para solucionar este problema se agregó el documento service.asmx como predeterminado en los Web Service RCS WS OFAC y RCS WS BDD (este procedimiento se lo puede encontrar en el manual CS - Risk Control Service - Manual de Instalación en los capítulos 4.6 Instalación de RCS Web Service OFAC y 4.7 Instalación de RCS Web Service BDD)

Documents

CS - OFAC Web Service - Manual Técnico