Identity
This library implements a client that combines the National Registry V2 Client and the RSK Company Client and returns an Identity object depending on whether the provided nationalId belongs to a company or a person.
To use it you need to have proxy the X-Road socat service:
./scripts/run-xroad-proxy.sh
or
kubectl -n socat port-forward svc/socat-xroad 8080:80
and make sure the environment variables
XROAD_BASE_PATH_WITH_ENV, XROAD_TJODSKRA_MEMBER_CODE, XROAD_TJODSKRA_API_PATH, COMPANY_REGISTRY_XROAD_PROVIDER_ID and XROAD_CLIENT_ID are available.Add the service to your module imports and make sure you have the required configuration:
import {
ConfigModule,
IdsClientConfig,
XRoadConfig,
} from '@island.is/nest/config'
import { NationalRegistryClientConfig } from '@island.is/clients/national-registry-v2'
import { CompanyRegistryConfig } from '@island.is/clients/rsk/company-registry'
import { IdentityClientModule } from '@island.is/clients/identity'
@Module({
imports: [
IdentityClientModule,
ConfigModule.forRoot({
isGlobal: true,
load: [
IdsClientConfig, // recommended
NationalRegistryClientConfig,
XRoadConfig,
CompanyRegistryConfig,
]
})
],
})
Then you'll have access to the Idenity Client Service:
import { Identity, IdentityClientService } from '@island.is/clients/identity'
@Injectable()
export class SomeService {
constructor(private readonly identityService: IdentityClientService) {}
async getPerson(nationalId: string): Promise<Identity> {
return this.identityService.getIdentity(nationalId)
}
}
Last modified 1mo ago